Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


Tópicos:

Índice

Dica
titleDICA:

Exemplo de dica no corpo da página.

1. Primeiro tópico da Página

Loremipsum22

2. Exemplo de bloco de código

Bloco de código
languagejs
themeMidnight
linenumberstrue
PATCH /restapis/restapi_id/documentation/versions/version HTTP/1.1
Host: apigateway.region.amazonaws.com
Content-Type: application/json
X-Amz-Date: YYYYMMDDTttttttZ
Authorization: AWS4-HMAC-SHA256 Credential=access_key_id/YYYYMMDD/region/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=sigv4_secret
 
{
    "patchOperations": [{
        "op": "replace",
        "path": "/description",
        "value": "My API for testing purposes."
    }]
}

2.1. Primeiro tópico da Página

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetur. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

2.2. Primeiro tópico da Página

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetur. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.

3. Primeiro tópico da Página


Loremipsum22 Nota
titleObservação:
Adicionando observações no corpo do texto

1- Sobre o documento

Descreve o escopo principal da funcionalidade, a integração com os serviços de Callback da Mobile Saúde, padrões de entrada e retorno, parâmetros e protocolos utilizados. A segunda parte do documento lista os endpoints da API de Atualização Cadastral, com parâmetros de entrada e retorno.


2- Sobre o escopo da funcionalidade

A funcionalidade tem comportamentos pre definidos, e seu comportamento padrão foi detalhado num passo a passo que ajudará sua operadora a analisar se a funcionalidade padrão tem aderência total ou parcial ao seu fluxo de atendimento ao beneficiário.


3- Definições sobre a plataforma de callback

O callback é uma integração oferecida pela Mobile Saúde, onde é possível cadastrar uma url que servirá de ponto de comunicação entre as APIs da Mobile Saúde e seu sistema, os pontos de entrada serão descritos nesse documento.


4- Tentativas de acesso

Caso sua aplicação possua uma url de callback configurada, o sistema da Mobile Saúde realizará uma chamada ao serviço sempre que determinada ação for executada. Toda tentativa de comunicação será logada e novas tentativas poderão ser acionadas pelos administradores.
Se houver algum problema de comunicação ou falha na execução do serviço, a Mobile Saúde executará automaticamente novas tentativas de comunicação.


5- Definições sobre a API

A API documentada, é a mesma utilizada pelos aplicativos, área do beneficiário web e painel administrativo. O parâmetro que identifica sua operadora e também a aplicação contratada se chama "mshash" e deve ser enviado em quase todas as requisições para identificação e segurança. O valor desse parâmetro pode ser encontrado em seu painel administrativo.

Pesquisa em tempo real