API DigitalNZ API
Consulte DigitalNZ API, do provedor digitalnz.org, versão 3: documentação, especificação OpenAPI 3.0.1 e referências para planejar a integração.
digitalnz.org · Versão 3
Conheça a plataforma
O que integrar com DigitalNZ API
Descrição técnica preservada da especificação de origem. A versão do contrato ajuda a identificar a API; confirme a disponibilidade atual no fornecedor.
OpenAPI specification of DigitalNZ's Record API. For more information about the API see digitalnz.org/developers. To learn more about the metadata/fields used in the API see the Metadata Dictionary. To get a sense of what content is available via the API take a look at the search feature on the DigitalNZ website. The terms of use specify how developers can use the DigitalNZ API.
Ficha técnica
Como funciona a integração
Versões, permissões, preços e limites podem mudar. Consulte a documentação da plataforma antes de implementar.
Do planejamento à produção
Checklist para integrar DigitalNZ API
- Defina o fluxo. Identifique quais dados precisam circular, o sistema de origem e o resultado esperado.
- Leia os requisitos oficiais. Verifique acesso à API, plano necessário, versão e ambiente de testes.
- Configure o acesso com segurança. Guarde credenciais secretas no servidor e conceda apenas as permissões necessárias. Restrinja chaves públicas conforme a documentação do fornecedor.
- Teste a primeira requisição. Valide os campos, a paginação e o formato de resposta com dados de teste.
- Prepare o tratamento de falhas. Considere limites de requisição, retentativas com espera e prevenção de operações duplicadas.
- Acompanhe a integração. Registre erros sem expor dados sensíveis e monitore alterações na API.