Autenticação
Chave de API
Para acessar qualquer endpoint do Idexa referente à leitura de documentos, é necessário uma chave de API. Você pode utilizar uma padrão gerada para sua empresa que você recebeu no seu contato com nossa equipe de suporte e que se encontra disponível em https://web.idexa.pixforce.ai/api-keys ou ainda gerar uma nova chave nesta mesma página.
Sua chave de API deve ser enviada como um Header, com o nome X-API-KEY.
Nos próximos passos, serão mostrados como enviar um documento, e neles, como utilizar a X-API-KEY corretamente.
Lembre-se que com a sua chave, você poderá controlar quem utiliza sua conta, e quem efetuou os uploads de documentos, caso seja necessário.
URL para chamadas dos Endpoints
Após a criação da conta e geração da chave de API, utilize a URL do ambiente em suas chamadas.
Ambiente | URL |
---|---|
Produção | https://api.idexa.pixforce.ai |