Pular para o conteúdo principal

Introdução

DocsM3 é uma Plataforma Cloud de gestão de documentos que suporta todos os padrões de XML, PDF e faturas. Integração com SEFAZ, Prefeituras e Receita Federal. Uso de Inteligência Artificial para leitura de documentos por imagem. A experiência do usuário é amigável e performatica via Web e Aplicativo Celular. Possui APIs de integração REST possibilitando integração com qualquer sistema corporativo.

Overview

Fluxo de Dados​

Atenção

O fluxo de dados pode variar de acordo com o nível de processos requeridos pelo Sistema Corporativo. A representação abaixo considera um cenário básico de integração ponta-a-ponta.

Overview

Fluxo de Integração​

Atenção

O fluxo de integração pode variar de acordo com o nível de processos requeridos pelo Sistema Corporativo. A representação abaixo considera um cenário básico de integração ponta-a-ponta.

O processo de integração ponta-a-ponto em geral segue a seguinte sequência:

Enviar documento → Receber Mensagens → Receber Eventos → Atualizar Workflow → Baixar Documento

Enviar Documento​

Overview

Receber Mensagens​

Overview

Receber Eventos​

Overview

Atualizar Workflow​

Overview

Baixar Documento​

Overview

Base URL​

A API do DocsM3 é construída com base nos princípios REST e é servida sobre HTTPS. Para garantir a privacidade dos dados, HTTP não criptografado não é suportado.

A URL base para todos os endpoints da API é:

Produção

https://api.docsm3.com

Testes

https://uat-api.docsm3.com

Autenticação​

A autenticação na API do DocsM3 é realizada através do cabeçalho Authorization com um token Basic. Para autenticar, você precisa incluir o cabeçalho Authorization com a palavra Basic seguida da sua chave de API nas suas requisições, assim:

Authorization: Basic <Your-Token>

Solicite um token de autenticação através do endereço de e-mail: suporte@docsm3.com

Códigos de Resposta​

A API retorna códigos de resposta HTTP padrão para indicar o sucesso ou falha de uma solicitação de API. Aqui estão alguns exemplos:

CódigoDescrição
200A solicitação foi bem-sucedida.
400A solicitação é inválida ou não pode ser atendida.
401A solicitação requer autenticação do usuário.
403O servidor entendeu a solicitação, mas se recusa a autorizá-la.
404O recurso solicitado não pôde ser encontrado.
429Muitas solicitações.
500O servidor encontrou uma condição inesperada que o impediu de atender à solicitação.

Erros​

A API do DocsM3 retorna códigos de erro legíveis por máquina e mensagens de erro legíveis por humanos.

Aqui está um exemplo de como uma resposta de erro se parece:

{
  "error": {
    "code": "not_found",
    "message": "O recurso solicitado não foi encontrado."
  }
}

Códigos de Erro​

Aqui está uma lista de todos os códigos de erro que a API do DocsM3 retorna:

bad_request​

  • Status: 400
  • Problema: A solicitação está malformada, faltando campos obrigatórios, usando tipos de dados errados ou sendo sintaticamente incorreta.
  • Solução: Verifique a solicitação e certifique-se de que está devidamente formatada.

unauthorized​

  • Status: 401
  • Problema: A solicitação não foi aplicada porque não possui credenciais de autenticação válidas para o recurso alvo.
  • Solução: Certifique-se de que está usando a chave de API ou token de acesso corretos.

forbidden​

  • Status: 403
  • Problema: O servidor entendeu a solicitação, mas se recusa a atendê-la porque o cliente não tem permissão adequada.
  • Solução: Certifique-se de que você tem as permissões necessárias para acessar o recurso.

not_found​

  • Status: 404
  • Problema: O servidor não encontrou nada correspondente ao URI da solicitação.
  • Solução: Verifique a solicitação e certifique-se de que o recurso existe.

conflict​

  • Status: 409
  • Problema: Outro recurso já usa o mesmo identificador. Por exemplo, o slug da conta deve ser único.
  • Solução: Altere o identificador para um valor único.

invite_expired​

  • Status: 410
  • Problema: O convite expirou.
  • Solução: Gere um novo convite.

unprocessable_entity​

  • Status: 422
  • Problema: O servidor não conseguiu processar a solicitação porque contém dados inválidos.
  • Solução: Verifique a solicitação e certifique-se de que os dados de entrada são válidos.

rate_limit_exceeded​

  • Status: 429
  • Problema: A solicitação foi limitada por taxa.
  • Solução: Aguarde um pouco e tente novamente.

internal_server_error​

  • Status: 500
  • Problema: O servidor encontrou uma condição inesperada que o impediu de atender à solicitação.
  • Solução: Tente novamente mais tarde. Se o problema persistir, entre em contato com o suporte.

Próximos passos?​

  • Enviar documentos para integração → ver mais