Skip to main content

Como começar

Requisitos para Realizar Requisições HTTP para Utilização de API​

Para utilizar a API do Dynadok, é essencial atender a alguns requisitos básicos que garantem uma integração segura e eficiente. Abaixo, seguem os principais requisitos:

1. Acesso à Internet​

  • É necessário ter uma conexão estável à Internet para enviar e receber requisições HTTP.

2. Chave de API (API Key)​

  • A maioria das APIs, incluindo a do Dynadok, requer autenticação. Você precisará de uma chave de API (API Key) fornecida pelo serviço para realizar requisições autenticadas.

3. Cliente HTTP​

  • Ferramentas ou bibliotecas que permitem enviar requisições HTTP. Exemplos incluem:
    • cURL: Utilitário de linha de comando para transferir dados com URLs.
    • Postman: Aplicação para testar APIs.
    • Bibliotecas em Linguagens de Programação:
      • Python: requests
      • JavaScript: axios, fetch
      • Java: HttpClient
      • C#: HttpClient

4. Conhecimento de Métodos HTTP​

  • Familiaridade com os métodos HTTP usados nas requisições, como:
    • GET: Para solicitar dados.
    • POST: Para enviar dados.
    • PUT: Para atualizar dados.
    • DELETE: Para remover dados.

5. Estrutura de Requisição​

  • Compreensão dos elementos essenciais de uma requisição HTTP:
    • URL Endpoint: O endereço específico da API que será acessado.
    • Headers: Incluem informações como Content-Type e Authorization.
    • Body: Necessário em requisições como POST e PUT para enviar dados no formato JSON ou XML.

6. Formato de Dados​

  • Conhecimento dos formatos de dados aceitos pela API, como JSON ou XML, e como estruturar esses dados corretamente.

7. Ambiente de Desenvolvimento​

  • Um ambiente de desenvolvimento configurado com as bibliotecas necessárias para fazer requisições HTTP.

8. Manuseio de Respostas​

  • Habilidade para interpretar e tratar as respostas da API, incluindo códigos de status HTTP e mensagens de erro.

Exemplo de Requisição HTTP usando Python e a Biblioteca requests​

import requests

url = 'https://api.dynadok.com/v1/api/documents'

payload = {'type': 'CERTIDAO_DE_NASCIMENTO'}
files=[
  ('files',('nome_do_arquivo.pdf',open('nome_do_arquivo.pdf','rb'),'application/pdf'))
]
headers = {
  'x-api-key': '••••••'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Atendendo a esses requisitos, você estará pronto para integrar e utilizar a API do Dynadok de forma eficaz e segura.

URL Base​

https://api.dynadok.com