Principais conceitos e uso dos endpoints Certiface API
Se este é seu primeiro acesso à Certiface API, não se preocupe - fornecemos todo o suporte necessário para você aproveitar ao máximo os recursos disponíveis.
Padrões e tecnologias
Certiface API foi projetada e implementada seguindo as melhores práticas e padrões amplamente adotados no desenvolvimento de APIs.
Tem por base a arquitetura REST, permite que os sistemas se comuniquem por meio de solicitações HTTP, usando os métodos (GET, POST, PUT, DELETE, etc.) e os recursos (URLs) para manipulação e transferência de dados.
Certiface API permite a troca de dados no formato JSON e utiliza códigos de status HTTP padronizados para fornecer informações claras sobre o resultado das solicitações.
Respostas padrão HTTP
Certiface API utiliza códigos de resposta padrão do HTTP para mostrar o resultado de uma requisição.
| Código de resposta | Descrição | Detalhamento |
|---|---|---|
| 2XX | Representam sucesso, indicando que a requisição foi bem-sucedida. | |
| 4XX | Usados para mostrar erros relacionados aos dados fornecidos ou problemas do lado do cliente. | Erros do cliente: Requisição com dados inválidos ou incorretos. Ticket expirado ou inativo, etc. |
| 5XX | Mostram erros do lado do servidor, como falhas internas ou problemas inesperados. | Erros do servidor Oiti: Falha. Uma solicitação válida foi feita pelo cliente, mas o servidor falhou ao concluir a solicitação. |
Os códigos de status servem para depurar e diagnosticar problemas ao usar Certiface API. Eles ajudam a entender se uma requisição foi bem-sucedida, se há problemas com as informações fornecidas ou se ocorreu um erro no servidor.
Essa classificação dos códigos de status permite uma identificação e tratamento eficientes das situações, possibilitando a resolução de falhas e aprimoramentos contínuos para melhorar a experiência do usuário.
Autenticação
Para utilizar a Certiface API, é necessário obter as credenciais de autenticação. Essas informações serão utilizadas para autenticar suas solicitações na API de forma segura.
O time da Oiti entrará em contato para fornecimento dos dados username e password
Parâmetros
Em cada endpoint da API, são disponibilizados todos os parâmetros necessários para realizar testes e interações.
Parâmetros obrigatórios
Atente-se! Os campos obrigatórios são destacados em vermelho e devem ser preenchidos corretamente.
Esses parâmetros são divididos em duas categorias: Path Params e Body Params.
Os Path Params são informações fornecidas diretamente na URL para especificar a ação ou recurso desejado.
Os Body Params são parâmetros incluídos no corpo da requisição e devem conter o máximo de informações relevantes para obter resultados mais precisos.