Funcionalidades

OpenAPI

API documentada no padrão OpenAPI, para o sistema não virar ilha.

OpenAPI

Sistema sem API é sistema que vai virar ilha na primeira necessidade nova. Como o código é da sua empresa, a API existir e ser documentada é o que garante que qualquer fornecedor consiga trabalhar com ele depois.

O que costuma entrar

  • Contrato em OpenAPI

    Especificação no padrão OpenAPI, gerada junto com o código — documentação que não descola da implementação.

  • Autenticação e escopo

    Credencial de serviço com permissão mínima por integração. Cada consumidor recebe só o que precisa.

  • Versionamento

    Mudança que quebra contrato entra em versão nova, com a anterior mantida pelo prazo combinado.

  • Webhooks

    Em vez de o outro lado ficar perguntando, o sistema avisa quando o evento acontece, com reenvio em caso de falha.

Como a Nivrix constrói

  1. Contrato antes do código

    A especificação é acordada primeiro; quem vai consumir consegue começar em paralelo.

  2. Limite e registro

    Cada consumidor tem limite de chamada e registro de uso — para um integrador não derrubar a operação.

  3. Ambiente de teste

    Quem integra testa contra um ambiente separado, com dado de teste, antes de tocar produção.

Perguntas sobre este módulo

A API é minha também?

Sim. Ao fim do projeto o código é da sua empresa, API e especificação incluídas. Outro fornecedor consegue continuar a partir da documentação.

Dá para outro sistema escrever dados?

Dá, com as mesmas regras de validação e permissão da interface. Nenhum caminho de escrita confia no que chega sem verificar no servidor.

Vamos entender a sua operação.

Faça o diagnóstico ou veja como trabalhamos. Sem compromisso.