¿Cómo agregar la función API a una página PHP simple?

La interfaz de programación de aplicaciones es un sistema que contiene un conjunto de reglas, protocolos o herramientas que ayudan a proporcionar interacción entre dos aplicaciones o software mediante el acceso a datos estándar. Es muy similar a un servicio web utilizado en el desarrollo de páginas web o aplicaciones móviles. Una aplicación puede llamar a la API de otros programas para utilizar alguna funcionalidad. Las API obtienen requests y devuelven el resultado en el sistema de software del programador.
Si el sistema se comunica con las bases de datos, las extensiones de PHP exponen las API.

Ejemplos: API de Google Maps, API de YouTube.

requisitos previos:

  1. PHP
  2. biblioteca cURL de PHP

Programa:

<?php
  
$url = 'RequiredLink';
$data = [
    'collection'  => 'RequiredAPI'
];
   
$curl = curl_init($url);
  
function APIcall($method, $url, $data) {
    $curl = curl_init();
      
    switch ($method) {
        case "POST":
            curl_setopt($curl, CURLOPT_POST, 1);
            if ($data)
                curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
            break;
        case "PUT":
            curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PUT");
            if ($data)
                curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
            break;
    }
     
    curl_setopt($curl, CURLOPT_URL, $url);
    curl_setopt($curl, CURLOPT_HTTPHEADER, array(
        'APIKEY: RegisteredAPIkey',
        'Content-Type: application/json',
    ));
     
    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
    curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC);
    $result = curl_exec($curl);
      
    if(!$result) {
        echo("Connection failure!");
    }
    curl_close($curl);
    return $result;
}
?>

Tipos de API web: las API web son aquellas a las que se puede acceder a través de Internet.

  1. API abiertas: estas API están disponibles públicamente ya que no hay restricciones.
  2. APIs de socios: El usuario necesita licencia y derechos especiales para acceder a este tipo de APIs.
  3. API privadas: propiedad de empresas para sistemas internos.
  4. API compuestas: es una combinación de API de datos y servicios para acelerar el proceso de ejecución.

Además de las cuatro anteriores, también hay muchas otras API disponibles. Algunas API están disponibles en Internet, no necesita instalar el software.

Tipos de API de servicios web: un ejemplo muy común, el uso de API de proceso de pago en lugar de desarrollar nuestro propio proceso de pago. Las API de servicios web son métodos independientes de la plataforma a los que se accede mediante una conexión de red.

  1. SOAP: Protocolo simple de acceso a objetos que utiliza lenguaje de definición de servicios web o XML para la transferencia de datos. Es muy robusto. Estos se utilizan en la integración de API.
  2. JSON-RPC: Para la transferencia de datos utiliza JSON.
  3. REST: El conjunto de reglas incluye algunos principios arquitectónicos estándar para el intercambio de datos. Para realizar una solicitud, utiliza métodos HTTP para obtener, PUT, POST, PATCH, DELETE para todas las operaciones CRUD. Consume menos anchos de banda y también es cómodo acceder a los servicios en la nube.

    La salida REST está en forma de JSON:

    • GET: Lee o recupera información.
    • POST: Crea un nuevo registro.
    • PUT: Actualizar un registro.
    • ELIMINAR: Elimina un registro.

Cada vez que una aplicación utiliza las cuatro operaciones de base de datos para crear, leer, actualizar y eliminar. Se dice que utilizó la API REST. No todas las API son servicios web, pero todos los servicios web son API. Un ejemplo muy común son las API REST. Las API REST son la columna vertebral de Internet y los servicios web.

El archivo .htaccess se utiliza para asignar el URI de solicitud al servicio API REST.

<?php
require_once("MobileRestHandler.php");
  
$mobileRestHandler = new MobileRestHandler();
$mobileRestHandler->getAllMobiles();
?>
  • GET: Obtener información o recopilación de datos. Por ejemplo, detalles del producto de una tabla.

    $returnData = callAPI(‘GET’, ‘https://api.geeksforgeeks.com/url_for_get/’.$user[‘user’][‘buyer_id’], false);
    $respuesta = json_decode($returnData, true);
    $errores = $respuesta[‘respuesta’][‘errores’];
    $datos = $respuesta[‘respuesta’][‘datos’][0];

  • POST: Añade o crea nueva información como feedback o reseñas de algún restaurante.

    $arrayDeDatos = array(
    “comprador” => $usuario[‘usuario’][‘id_comprador’],
    “pago” => array(
    “númeroCuenta” => $este->solicitud->datos[‘NúmeroCuenta’],
    “ enrutamiento” => $this->request->data[‘routing’],
    “method” => $this->request->data[‘method’]
    ),
    );
    $apiCall = APIcall(‘POST’, ‘https://api.geeksforgeeks.com/url_for_post/’, json_encode($data_array));
    $respuesta = json_decode($apiCall, true);
    $errores = $respuesta[‘respuesta’][‘errores’];
    $datos = $respuesta[‘respuesta’][‘datos’][0];

  • PUT: Actualiza los datos existentes.

    $arrayDeDatos = array(
    “cantidad” => ‘ImporteRequerido’
    );
    $updateData = APIcall(‘PUT’, ‘https://api.geeksforgeeks.com/url_for_put/’.$putParameter,
    json_encode($arrayOfData));
    $respuesta = json_decode($updateData, true);
    $errores = $respuesta[‘respuesta’][‘errores’];
    $datos = $respuesta[‘respuesta’][‘datos’][0];

  • ELIMINAR: Elimina los datos existentes.

    APIcall(‘ELIMINAR’, ‘https://api.geeksforgeeks.com/url_for_delete/’ . $required_id, false);

Usando API con PHP cURL:

  • Obtenga una clave API: cuando comience con las API, debe registrarse y obtener una clave que es una string de letras y números. Esta clave API solo se usa al realizar una solicitud para que la API del servidor reconozca al usuario como un usuario registrado.
  • Probar API con aplicaciones PHP: este proceso verifica si todo funciona como se esperaba.
  • Desarrolle la aplicación PHP requerida mediante API. Cree o desarrolle la aplicación utilizando las API necesarias.

Pasos para crear la API REST:

  1. Cree una base de datos y una tabla DB.
  2. Establecer conexión con la base de datos.
  3. Cree un archivo API REST.
    • Crear índice o archivo HTML.
    • Obtenga los registros de la base de datos a través de cURL

Publicación traducida automáticamente

Artículo escrito por geetanjali16 y traducido por Barcelona Geeks. The original can be accessed here. Licence: CCBY-SA

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *