# Índice

1. [Quando usar o endpoint de informações de serviço](#quando-usar)
2. [Enviando uma requisição](#criacao-pedido)
3. [Parâmetros de configuração](#parametros-configuracao)
4. [Estrutura da resposta](#estrutura-de-resposta)
5. [Exemplo ultilizando a consulta Receita Federal / CNPJ](#exemplo-receita-federal-cnpj)

## [Quando usar o endpoint de informações de serviço](#quando-usar)
Esse endpoint retorna informações importantes sobre um serviço, tais como:

- Taxa de sucesso de um serviço na última hora;
- Tempo médio de execução de um serviço na última hora;
- Custo adicional de um serviço.

> Este endpoint não tem custo.

> Você pode realizar até 100 consultas por hora, para cada um dos serviços da Infosimples.


## [Enviando uma requisição](#criacao-pedido)
|                    |                                               |
| ------------------ | --------------------------------------------- |
| Método HTTP        | GET                                           |
| URL                | https://api.infosimples.com/api/admin/service |
| Formato do retorno | JSON                                          |


## [Parâmetros de configuração](#parametros-configuracao)
`*`: Parâmetro obrigatório
| Parâmetro | Descrição                                                                                                                       |
| --------- | ------------------------------------------------------------------------------------------------------------------------------- |
| token*    | Chave de autenticação da API. É com o token que a API reconhece e autoriza quem está fazendo a consulta.                        |
| service   | Especifica o serviço a ser consultado. Exemplo: para o caso **Receita Federal / CNPJ** , usamos o valor `receita-federal/cnpj`. |


## [Estrutura da resposta](#estrutura-de-resposta)
Uma resposta do endpoint de status possui, dentro da chave `data`, os seguintes campos:
| Campo          | Tipo    | Descrição                                                                                                 |
| -------------- | ------- | --------------------------------------------------------------------------------------------------------- |
| service        | string  | Especifica o `path` do serviço consultado.                                                                |
| name           | string  | Nome do serviço consultado.                                                                               |
| price_extra    | string  | Preço adicional de um serviço. Caso um serviço não tenha valor adicional, será retornado o valor `"0.0".` |
| variable_price | boolean | Indica se o serviço possui preço adicional variável.                                                      |
| paused         | boolean | Indica se o serviço está pausado ou não.                                                                  |
| success_rate   | number  | Taxa de sucesso do serviço nos últimos 60 minutos. É um valor entre **0.0** e **1.0**.                    |
| duration_ms    | number  | Tempo médio das consultas com sucesso nos últimos 60 minutos. Valor em milissegundos.                     |

## [Exemplo ultilizando a consulta Receita Federal / CNPJ](#exemplo-receita-federal-cnpj)
Por exemplo, para a consulta Receita Federal / CNPJ é necessário informar usar o parâmetro `receita-federal/cnpj`.

### Exemplo de requisição

#### Python
```python
# Testado com: Python 3.10.19, Python 3.14.0
import requests

url = "https://api.infosimples.com/api/admin/service"
args = {
  "token": "VALOR_DO_PARAMETRO_TOKEN",
  "service": "VALOR_DO_PARAMETRO_SERVICE"
}

response = requests.post(url, args)
response_json = response.json()
response.close()

print(response_json)
```


### Exemplo de resposta

#### Sucesso
```json
{
    "code": 200,
    "code_message": "A requisição foi processada com sucesso.",
    "data": {
        "service": "receita-federal/cnpj",
        "name": "Receita Federal / CNPJ",
        "price_extra": "0.0",
        "variable_price": false,
        "paused": false,
        "success_rate": 0.997,
        "duration_ms": 1798
    }
}
```


#### Erro
```json
{
    "code": 612,
    "code_message": "Os dados não existem no banco de dados do serviço de origem.",
    "errors": [
        "O serviço abc/xyz não foi encontrado."
    ]
}
```


## Precisa de ajuda?
Ainda tem alguma dúvida ou precisa de ajuda na sua integração? Entre em contato em [suporte@infosimples.com.br](mailto:suporte@infosimples.com.br) e receba ajuda da nossa equipe técnica altamente qualificada.