Árvore de páginas

Versões comparadas

Chave

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

...

Além disso, a API de provedores foi melhorada para que suas funções sejam mais bem definidas.


Endpoints da API ProvedorController

1. Consulta de Provedores Cadastrados

URL: /provedor

Método HTTP: GET

...

Exemplo de Corpo da Resposta:

[
    {
        "idProvedor": 1,
        "nome": "NOME_PROVEDOR",
        "tipo": "TIPO_PROVEDOR",
        "intervaloBusca": 1,
        "urls": [
            {
                "tipo": "TIPO_URL",
                "url": "URLPROVEDOR.COM.BR",
                "ambiente": "homolog"
            }
        ]
    },
    {
        "idProvedor": 2,
        "nome": "NOME_PROVEDOR_2",
        "tipo": "TIPO_PROVEDOR",
        "intervaloBusca": 1,
        "urls": [
            {
                "tipo": "TIPO_URL",
                "url": "URLPROVEDOR2.COM.BR",
                "ambiente": "homolog"
            }
        ]
    }
]

2. Consulta de Provedor por ID

URL: /provedor/{id}

Método HTTP: GET

...

Exemplo de Corpo da Resposta:


{
    "idProvedor": 1,
    "nome": "NOME_PROVEDOR",
    "tipo": "TIPO_PROVEDOR",
    "intervaloBusca": 1,
    "urls": [
        {
            "tipo": "TIPO_URL",
            "url": "URLPROVEDOR.COM.BR",
            "ambiente": "homolog"
        }
    ]
}

3. Criar Novo Provedor

URL: /provedor

Método HTTP: POST

...

ProvedorDTO (Request Body): Dados do novo provedor.


{
    "nome": "NOME_PROVEDOR",
    "tipo": "TIPO_PROVEDOR",
    "intervaloBusca": 1,
    "urls": [
        {
            "tipo": "TIPO_URL",
            "url": "URLPROVEDOR.COM.BR",
            "ambiente": "homolog"
        }
    ]
}

Autenticação: Requer token JWT no cabeçalho Authorization.

...

Exemplo de Corpo da Resposta:

{
    "idProvedor": 17,
    "nome": "NOME_PROVEDOR",
    "tipo": "TIPO_PROVEDOR",
    "intervaloBusca": 1,
    "urls": [
        {
            "tipo": "TIPO_URL",
            "url": "URLPROVEDOR.COM.BR",
            "ambiente": "homolog"
        }
    ]
}

4. Atualizar Dados de um Provedor

URL: /provedor/{id}

Método HTTP: PUT

...

ProvedorDTO (Request Body): Dados atualizados do provedor.

{
    "nome": "NOME_PROVEDOR_ATUALIZADO",
    "tipo": "TIPO_PROVEDOR",
    "intervaloBusca": 1,
    "urls": [
        {
            "tipo": "TIPO_URL",
            "url": "URLPROVEDOR.COM.BR",
            "ambiente": "homolog"
        }
    ]
}

Autenticação: Requer token JWT no cabeçalho Authorization.

...

Exemplo de Corpo da Resposta:

{
    "idProvedor": 1,
    "nome": "NOME_PROVEDOR_ATUALIZADO",
    "tipo": "TIPO_PROVEDOR",
    "intervaloBusca": 1,
    "urls": [
        {
            "tipo": "TIPO_URL",
            "url": "URLPROVEDOR.COM.BR",
            "ambiente": "homolog"
        }
    ]
}


04. DEMAIS INFORMAÇÕES

Não se aplica

...