API pública do CUSP

Gestão de organizações, pontos de atendimento eServiços públicos

Introdução

A API (Application Programming Interface) pública do CUSP permite a integração de sistemas externos para gerir e consultar três entidades nucleares do catálogo: organizações, pontos de atendimento e serviços públicos. Esta versão foi desenhada de forma minimalista, no sentido de se focar nos endpoints essenciais de consulta e criação.

• Nome: API Pública do CUSP

• URL: disponível brevemente

• Clientes conhecidos (entidades e internos): disponível brevemente

• Equipa responsável: ARTE - Agência para a Reforma Tecnológica do Estado, I.P.

Autenticação

Chaves de API ( API Key ): este método de autenticação requer que a aplicação forneça uma API Key exclusiva (providenciada na subscrição).

Especificações da API

Formato da informação

• Dados estruturados

• Fonte: OpenAPI

Especificações técnicas

• Consulte o Swagger na área dos programadores

Recursos

A API está em desenvolvimento contínuo, com melhorias incrementais ao nível da arquitetura, dos contratos de serviço e dos mecanismos de integração. Durante este período poderão ocorrer ajustes aos DTO (Data Transfer Objects), resultantes de otimizações do modelo de domínio, para garantir maior consistência interna ou acomodar novos requisitos funcionais.

Até à estabilização da versão final, as integrações realizadas devem ser consideradas suscetíveis a alterações. Recomenda-se que os consumidores prevejam capacidade de adaptação a eventuais atualizações nos contratos.

Organizações (organisation)

O campo locale padrão é PT quando não especificado.

Método	Endpoint	Descrição
GET	/organisation	Listar as organizações válidas na data presente
POST	/organisation	Iniciar processo de criação de organizações
GET	/organisation/config	Listar as organizações
GET	/organisation/{id}	Obter organizações por id
PUT	/organisation/{id}	Edita uma organização
POST	/organisation/{id}/version	Iniciar processo de criação de uma nova entidade
GET	/organisation/{identifier}/identifier	Obter organizações ativas por identificador ( ORG-XXXXXXXXX)
GET	/organisation/{identifier}/versions	Obter as versões de uma entidade por identificador
POST	/organisation/search	Pesquisa organizações válidas na data presente
POST	/organisation/config/search	Pesquisa organizações
POST	/organisation/validate	Valida um DTO de entidade

Identificador: Formato ORG-XXXXXXXXX (por ex.: ORG-000009069 )

Pontos de atendimento ( /point-of-care )

O campo locale padrão é PT quando não especificado.

Método	Endpoint	Descrição
GET	/point-of-care	Listar os pontos de atendimento válidos na data presente
POST	/point-of-care	Iniciar processo de criação de pontos de atendimento
GET	/point-of-care/config	Listar os pontos de atendimento
GET	/point-of-care/{id}	Obter pontos de atendimento por id
PUT	/point-of-care/{id}	Edita um ponto de atendimento
GET	/point-of-care/{id}/version	Iniciar processo de criação de um novo ponto de atendimento com base num já existente
POST	/point-of-care/{identifier}/identifier	Obter o pontos de atendimento por identificador ( POC-XXXXXXXXX )
POST	/point-of-care/search	Pesquisa pontos de atendimento válidos na data presente
POST	/point-of-care/config/search	Pesquisa pontos de atendimento
POST	/point-of-care/validate	Validar um ponto de atendimento

Serviços ( /service )

O campo locale padrão é PT quando não especificado.

Método	Endpoint	Descrição
GET	/service	Listar os serviços válidos na data presente
POST	/service	Iniciar o processo de criação de serviços
GET	/service/config	Listar os serviços
GET	/service/{id}	Obter os serviços por id
PUT	/service/{id}/id	Edita um serviço
POST	/service/{id}/version	Iniciar o processo de criação de uma nova versão de serviço
GET	/service/{identifier}/identifier	Obter os serviços ativos por identificador ( SRV-XXXXXXXXX )
GET	/service/{identifier}/channels	Obter os serviços ativos por identificador (canais)
POST	/service/search	Pesquisa os serviços válidas na data presente
POST	/service/config/search	Pesquisa um serviços
POST	/service/validate	Validar um serviço

API pública do CUSP:

120KB

cusp-public-api.json

Open

Este contéudo também pode ser descarregado em versão pdf:

303KB

SD-API Pública do CUSP_ Gestão de Organizações, Pontos de Atendimento e Serviços Públicos.pdf

PDF

Open