API Rest

Integração do Landing SDK por meio da API Rest.

A API de Landing é usada para gerar uma URL da página de destino por meio de uma apikey válida, para que essa URL possa ser usada pelo cliente para o consumo de seus usuários.

Como fazer a chamada

Assim que a página de destino (landing page) for gerada e publicada, a URL que será usada para chamar a API será fornecida ao cliente da seguinte maneira:

curl -X POST \
  https://landing.identity-platform.io/api/landing \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: CLIENT_API_KEY' \
  -d '{}'

Essa chamada retornará a URL da página de destino e o status da seguinte maneira:

{
    "status": true,
    "url": "https://test.landing.identity-platform.io"
}

---

UniqueUrl

Esta API oferece a possibilidade de gerar uma URL única codificada para uso por um único cliente, seja atribuindo a ele um customerId, o documentNumber ou ambos, da seguinte maneira:

curl -X POST \
  https://landing.identity-platform.io/api/landing \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
        "uniqueUrl": true,
        "customerId": "example",
        "documentNumber": "1111111111S"
     }'

Essa chamada gerará uma URL única com um tempo de validação de 15 minutos; após esse tempo, a URL expirará e também estará associada ao documentNumber que é enviado, o que significa que, se a captura do documento for de um número diferente, a operação será rejeitada na plataforma.

Você pode alterar o tempo de validade de uma URL adicionando o parâmetro time em minutos, assim:

curl -X POST \
  https://landing.identity-platform.io/api/landing \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
        "uniqueUrl": true,
        "customerId": "example",
        "documentNumber": "1111111111S",
        "time": "30"
     }'

Exemplos de implementações de API em diferentes linguagens

NodeJS

const fetch = require('node-fetch');

const apiUrl = 'https://landing.identity-platform.io/api/landing';
const apiKey = 'YOUR_API_KEY';

const postData = {
    uniqueUrl: true,
    customerId: 'example',
    documentNumber: '1111111111S',
    time: '30'
};

fetch(apiUrl, {
    method: 'POST',
    headers: {
        'Content-Type': 'application/json',
        'x-api-key': apiKey
    },
    body: JSON.stringify(postData)
})
.then(response => {
    if (response.ok) {
        return response.json();
    } else {
        throw new Error('Erro');
    }
})
.then(data => {
    console.log('Resposta:', data);
})
.catch(error => {
    console.error('Erro:', error);
});

Java

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;

public class Main {
    public static void main(String[] args) throws IOException {
        // Endpoint da API e chave da API
        String apiUrl = "api/landing";
        String apiKey = "YOUR_API_KEY";

        // Dados JSON a serem enviados
        String postData = "{\"uniqueUrl\": true, \"customerId\": \"example\", \"documentNumber\": \"1111111111S\", \"time\": \"30\"}";

        // Criar objeto URL
        URL url = new URL(apiUrl);

        // Criar conexão HTTP
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();

        // Definir método da solicitação
        connection.setRequestMethod("POST");

        // Definir cabeçalhos da solicitação
        connection.setRequestProperty("Content-Type", "application/json");
        connection.setRequestProperty("x-api-key", apiKey);

        // Habilitar saída e desabilitar entrada
        connection.setDoOutput(true);
        connection.setDoInput(false);

        // Escrever dados JSON na conexão
        try (OutputStream os = connection.getOutputStream()) {
            byte[] input = postData.getBytes("utf-8");
            os.write(input, 0, input.length);
        }

        // Obter código de resposta
        int responseCode = connection.getResponseCode();

        // Ler o corpo da resposta
        try (BufferedReader br = new BufferedReader(new InputStreamReader(connection.getInputStream(), "utf-8"))) {
            StringBuilder response = new StringBuilder();
            String responseLine = null;
            while ((responseLine = br.readLine()) != null) {
                response.append(responseLine.trim());
            }
            System.out.println("Código de resposta: " + responseCode);
        }
    }
}

PHP

<?php
// Endpoint da API e chave da API
$apiUrl = 'https://landing.identity-platform.io/api/landing';
$apiKey = 'YOUR_API_KEY';

// Dados JSON a serem enviados
$postData = json_encode(array(
    'uniqueUrl' => true,
    'customerId' => 'example',
    'documentNumber' => '1111111111S',
    'time' => '30'
));

// Definir cabeçalhos da solicitação
$headers = array(
    'Content-Type: application/json',
    'x-api-key: ' . $apiKey
);

// Inicializar sessão cURL
$ch = curl_init();

// Definir opções cURL
curl_setopt($ch, CURLOPT_URL, $apiUrl);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postData);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Executar solicitação cURL
$response = curl_exec($ch);

// Verificar erros
if(curl_errno($ch)){
    echo 'Erro: ' . curl_error($ch);
}

// Fechar sessão cURL
curl_close($ch);

// Imprimir resposta
echo $response;
?>