Skip to main content

Exemplos de uso

Envio de Documento com cURL​

A seguir, apresentamos um exemplo de como estruturar o código para utilizar o método de submissão de documentos da API do Dynadok. Este exemplo usa o utilitário de linha de comando cURL para enviar uma requisição POST com arquivos de documentos.

Estrutura do Código​

URL Endpoint​

  • https://api.dynadok.com/v1/api/documents: Este é o endpoint da API para submissão de documentos.

Cabeçalhos (Headers)​

  • x-api-key: Cabeçalho de autenticação que contém a chave da API fornecida pelo Dynadok. No exemplo, a chave da API é sua_chave_de_api.

Corpo da Requisição (Form Data)​

  • files: Parâmetro de formulário para enviar o arquivo de documento. No exemplo, o arquivo enviado é arquivo.pdf, localizado no diretório C:/caminho/.
  • type: Parâmetro de formulário para especificar o tipo de documento. No exemplo, o tipo de documento é "RG".

Passo a Passo​

  1. Definir o Endpoint: A URL do endpoint da API para onde a requisição será enviada.
  2. Incluir Cabeçalho de Autenticação: Adicionar o cabeçalho x-api-key com a chave de API fornecida.
  3. Adicionar Arquivos: Utilizar o parâmetro --form para anexar o arquivo de documento que será submetido.
  4. Especificar Tipo de Documento: Utilizar o parâmetro --form para definir o tipo de documento.

Requisição cURL​

curl --location 'https://api.dynadok.com/v1/api/documents' \
--header 'x-api-key: sua_chave_de_api' \
--form 'files=@"C:/caminho/arquivo.pdf"' \
--form 'type="RG"'

Obter Documento Processado com cURL​

curl -X GET "https://api.dynadok.com/v1/api/documents/[id do documento]" \
--header 'x-api-key: sua_chave_de_api'"