API REST

A API REST permite uma integração simplificada com aplicações executando nos mais variados ambientes. O uso desta API requer que os áudios a serem processados já estejam disponíveis. Caso deseje fazer streaming do áudio na medida em que a captura é realizada, recomenda-se o uso da API WebSocket.

Aviso

O acesso a API REST é feito através do endereço https://speechd.cpqd.com.br/bio/rest/v2, mediante o uso de um token de acesso. Consulte a seção Autenticação via token para detalhes sobre como obter um token.

Para uso do ASR e Biometria, será necessário ter dois tokens, um para cada produto.

A tabela abaixo contém os endpoint disponíveis:

Método	Endpoint	Descrição
POST	rest/v2/enroll	Cria ou atualiza um voiceprint biométrico através do upload de arquivo(s) de áudio.
POST	rest/v2/verify	Realiza a verificação biométrica com o upload de um arquivo (s) de áudio.

As informações dos usuários cadastrados ficam armazenados num repositório, que posse ser gerido através dos endpoints a seguir:

Método	Endpoint	Descrição
PUT	rest/v2/user/{id}/lock	Cria um bloqueio de escrita para alterar os dados do usuário.
DELETE	rest/v2/user/{id}/lock/{lock}	Remove o bloqueio de escrita do usuário.
GET	rest/v2/user/{id}/metainfo	Retorna meta-informações do usuário.
GET	rest/v2/user/{id}/audio	Retorna a lista de áudios no histórico do usuário.
GET	rest/v2/user/{id}/audio/{uuid}/info	Retorna informações sobre um arquivo de áudio.
GET	rest/v2/user/{id}/audio/{uuid}/data	Faz o download de um arquivo de áudio.
GET	rest/v2/user/{id}/lock	Retorna o estado do bloqueio criado para o usuário identificado por id.
DELETE	rest/v2/user/{id}/audio/{uuid}	Remove um áudio do usuário.
DELETE	rest/v2/user/{id}	Remove todos os dados de um usuário.