Wrapper APIs

Wrapper API 's

Wrapper API garantiza que los desarrolladores, al cambiar su código de uno de nuestros competidores a Netcore Email API , no tengan que reescribir ningún código.

Lo único que debe hacer un desarrollador al cambiar de competidores soportados es cambiar la clave de la API y la ruta de la URL de la API de los valores proporcionados por la competencia a los valores proporcionados por la API de Netcore Email , y ya está listo para comenzar a enviar correos electrónicos, así como para realizar todas las demás acciones, como la presentación de informes, la gestión de dominios, etc., que son compatibles con la plataforma de la API de Netcore Email.

Beneficios

Fácil integración: Se integra en 3 sencillos pasos, sin gastar demasiado tiempo en codificar y recodificar.
Reutilización del código: No pierda su tiempo y energías para codificar de nuevo, ya nos hemos encargado de ello. Todos sus formatos de solicitud y respuesta permanecen absolutamente iguales. Sólo tiene que cambiar las claves de la API y las URLs, y ya está listo.
Pruebas mínimas: no cambiar el código significa también no repetir el control de calidad. Su código simplemente funcionará.

Actualmente admitido

[Sendgrid] (doc: wrapper-apis # section-sendgrid)
[Mailgun] (doc: wrapper-apis # section-mailgun)

Pasos

Requisitos previos

Crear una cuenta de la API de correo electrónico de Netcore: ese es el primer paso, simplemente vaya y [Regístrese para una prueba gratuita] (https: // https: //email.netcorecloud.com/index.php/signup/registeruser) en la API de correo electrónico de Netcore.
[Obtenga su clave api] (ref: cómo-obtener-clave-api)

Pasos para la integración de API

Cambie la clave de API de su proveedor actual a la API de correo electrónico de Netcore
Cambie la URL de su proveedor actual a la URL respectiva proporcionada por la API de correo electrónico de Netcore
Despliegue y prueba.

Ejemplos

Sendgrid

URL de la API de correo electrónico de Netcore para la migración de Sendgrid: https://sgapi.netcorecloud.net

Sample SendGrid API v3 call:

curl --request POST \
--url https://api.sendgrid.com/v3/mail/send \
--header 'authorization: Bearer <YOUR SENDGRID API KEY>' \
--header 'content-type: application/json' \
--data '{"personalizations":[{"to":[{"email":"<RECIPIENT EMAIL ID>","name":"<RECIPIENT NAME>"}],"subject":"This is a test mail"}],"content": [{"type": "text/plain", "value": "Hello, How are you?"}],"from":{"email":"<FROM EMAIL ID>","name":"<FROM NAME>"}}'

Netcore Email API Wrapper API versión para la migración (Nota: la única diferencia es la URL y la clave API )

curl --request POST \
--url https://sgapi.netcorecloud.net/v3/mail/send \
--header 'authorization: Bearer <YOUR PEPIPOST API KEY>' \
--header 'content-type: application/json'  \
--data '{"personalizations":[{"to":[{"email":"<RECIPIENT EMAIL ID>","name":"<RECIPIENT NAME>"}],"subject":"This is a test mail"}],"content": [{"type": "text/plain", "value": "Hello, How are you?"}],"from":{"email":"<FROM EMAIL ID>","name":"<FROM NAME>"}}'

Mailgun

Netcore Email API URL para la migración de Mailgun - https://mgapi.netcorecloud.net

Ejemplo de Mailgun API V3 Call:

curl -s --user 'api:<MAILGUN API KEY>' \
https://api.mailgun.net/v3/<SENDING DOMAIN>/messages \
-F from='<FROM NAME><<FROM EMAILID>>' \
    -F to='<RECIPIENT EMAILID' \
    -F subject='Hello' \
    -F text='Testing some Mailgun awesomeness!'

<?php
# Include the Autoloader (see "Libraries" for install instructions)
require 'vendor/autoload.php';
use Mailgun\Mailgun;

$client = new \Http\Adapter\Guzzle6\Client();
$mgClient = new \Mailgun\Mailgun('<MAILGUN API KEY>', $client);

# Instantiate the client.
$domain = "<SENDING DOMAIN>";

# Make the call to the client.
$result = $mgClient->sendMessage($domain, array(
    'from'    => '<FROM NAME> <<FROM EMAIL>>',
    'to'      => '<RECIPIENT NAME> <<RECIPIENT EMAIL>>',
    'subject' => 'Hello',
    'text'    => 'Testing some Mailgun awesomness!'
));
?>

Netcore Email API Wrapper API versión para la migración (Nota: la única diferencia es la URL y la clave API)

curl -s --user 'api:<PEPIPOST API KEY>' \
    https://mgapi.netcorecloud.net/v3/<SENDING DOMAIN>/messages \
    -F from='<FROM NAME> <FROM EMAILID>' \
    -F to='<RECIPIENT EMAILID' \
    -F subject='Hello' \
    -F text='Testing some Mailgun awesomeness!'

<?php
# Include the Autoloader (see "Libraries" for install instructions)
require 'vendor/autoload.php';
use Mailgun\Mailgun;

$client = new \Http\Adapter\Guzzle6\Client();
$mgClient = new \Mailgun\Mailgun('<PEPIPOST API KEY>', $client,'mgapi.pepipost.com');     //Changed API KEY and Added PEPIPOST DOMAIN
$mgClient->setApiVersion('v3');    //Changed API Version

# Instantiate the client.

$domain = "<SENDING DOMAIN>";

# Make the call to the client.
$result = $mgClient->sendMessage($domain, array(
    'from'    => '<FROM NAME> <<FROM EMAIL>>',
    'to'      => '<RECIPIENT NAME> <<RECIPIENT EMAIL>>',
    'subject' => 'Hello',
    'text'    => 'Testing some Mailgun awesomness!'
));
?>

¿Qué cubre?

SENDGRID

Envío de correo electrónico (POST) - /v3/mail/send
Añadir plantilla (POST) - /v3/templates/{template_id}/versions
Vista de plantillas (GET) - /v3/templates/{template_id}
Edición de plantillas (PATCH) - /v3/templates/{template_id}/versions/{version_id}
Stats (GET) - /v3/stats?start_date=2018-11-01&end_date=2018-12-10&aggregated_by=month&limit=1&offset=2
Obtener categorías - /v3/categories
Añadir supresión (POST) - /v3/asm/groups/<group_id>/suppressions
Añadir en supresión global (POST) - /v3/asm/suppressions/global (edited)

MAILGUN

Email Send (POST) - /v3/<domain_name>/messages
Get Stats - /v3/<domain_name>/stats
Get Tag - /v3/<DOMAIN_NAME>/tags
View single tag - /v3/<domain_name>/tags/<tag_name>
Add Domain (POST) - /v3/domains
Whitelist single emailid (DELETE) - /v3/<domain_name>/bounces/, /v3/<domain_name>/unsubscribes/, /v3/<domain_name>/complaints/
Add in suppression (POST) - /v3/<domain_name>/bounces, /v3/<domain_name>/complaints, /v3/<domain_name>/unsubscribes (edited)

Updated about 3 years ago