Manual de Uso da API

Bem-vindo ao manual de uso da API Mundo dos Vistos. Aqui você encontrará informações detalhadas sobre como utilizar as funções listar_documentos, listar_paises, e listar_categorias.

Autenticação

Todas as requisições devem ser autenticadas utilizando um token API. O token deve ser enviado no cabeçalho da requisição como Authorization: Bearer [SEU_API_KEY].

Para gerar seu API KEY (Chave API), acesse a área do parceiro: https://partner.soscanada.com.br/index.php/?pag=agt_fn

Endpoints

O endpoint base da API é: https://vis.to/api/

Listar Países

POST /api/listar_paises

Retorna uma lista de países disponíveis.

Requisição

POST /api/ HTTP/1.1
Host: vis.to
Authorization: Bearer [SEU_API_KEY]
Content-Type: application/x-www-form-urlencoded

action=listar_paises

Resposta

A resposta será um JSON com a lista de países, como abaixo:

{
    "status": "success",
    "data": {
        "paises": [
            {
                "pais": "Afeganistão",
                "idpais": "ID_DO_PAIS_FORNECIDO"
            },
            {
                "pais": "Africa do Sul",
                "idpais": "ID_DO_PAIS_FORNECIDO"
            },
            {
                "pais": "Albânia",
                "idpais": "ID_DO_PAIS_FORNECIDO"
            },
            {
                "pais": "Alemanha",
                "idpais": "ID_DO_PAIS_FORNECIDO"
            }
            // Outros países
        ]
    }
}

Listar Categorias

POST /api/listar_categorias

Retorna uma lista de categorias baseadas em um ID (fornecido através de listar_paises).

Requisição

POST /api/ HTTP/1.1
Host: vis.to
Authorization: Bearer [SEU_API_KEY]
Content-Type: application/x-www-form-urlencoded

action=listar_categorias&id=ID_DO_PAIS_FORNECIDO

Resposta

A resposta será um JSON com a lista de categorias, conforme exemplo abaixo:

{
    "status": "success",
    "data": {
        "categorias": [
            {
                "id": "ID_CATEGORIA_DO_VISTO_FORNECIDO",
                "tipo": "Estudos"
            },
            {
                "id": "ID_CATEGORIA_DO_VISTO_FORNECIDO",
                "tipo": "Turismo"
            },
            {
                "id": "ID_CATEGORIA_DO_VISTO_FORNECIDO",
                "tipo": "Estudos acima de 6 meses"
            },
            {
                "id": "ID_CATEGORIA_DO_VISTO_FORNECIDO",
                "tipo": "Trânsito"
            },
            {
                "id": "ID_CATEGORIA_DO_VISTO_FORNECIDO",
                "tipo": "Trabalho"
            }
            // Outras categorias
        ]
    }
}

Listar Documentos

POST /api/listar_documentos

Retorna uma lista de documentos baseados em um ID de visto (fornecido através de listar_categorias).

Requisição

POST /api/ HTTP/1.1
Host: vis.to
Authorization: Bearer [SEU_API_KEY]
Content-Type: application/x-www-form-urlencoded

action=listar_documentos&id=ID_CATEGORIA_DO_VISTO_FORNECIDO

Parâmetros

Resposta

A resposta será um JSON com as informações detalhadas sobre o visto:

{
    "status": "success",
    "data": {
        "texto_inicial": "Quem pretende visitar o Canadá a turismo... RESTANTE DO TEXTO DE APRESENTAÇÃO",
        "pais": "Canadá",
        "tipo_visto": "Turismo",
        "documentos_visto": {
            "Documentos básicos": [
                "Passaporte original, com validade mínima de 06 meses",
                "Cópia da última declaração de Imposto de Renda",
                "1 foto tipo 3x4 digitalizada",
                "Cópia do RG",
                "3 últimos extratos bancários",
                "3 últimos extratos de investimentos, aplicações, etc",
                "Formulários",
                "Passaportes anteriores originais"
            ],
            "Se estudante": [
                "Declaração escolar ou 3 últimos comprovantes de pagamento"
            ],
            "Caso a viagem seja para estudos": [
                "Carta de aceitação da escola",
                "Documentos que comprovem o pagamento do curso"
            ],
            "Se empregador": [
                "Cópia do contrato social",
                "Pró-labore ou DECORE dos 03 últimos meses"
            ],
            "Se empregado": [
                "Cópia dos holerites dos 03 últimos meses",
                "Cópia da carteira profissional (se empregado)"
            ],
            "inicial": "O Visto de Turismo ou visto de residente temporário é destinado...",
            "final": "Carta Convite e cópia de documento que comprove legalidade no país"
        },
        "prazo_medio_dias_uteis": 59,
        "taxa_consular": "CAD 216,00",
        "honorarios_mundo_dos_vistos": "R$ 410,00",
        "capital": "Ottawa",
        "lingua": "Inglês e Francês",
        "moeda": "Dólar CanaDense",
        "link_contrate": "LINK_FORNECIDO_PARA_CONTRATACAO_ONLINE"
    }
}