README

API Version: 1.7

Date: 9th July, 2024

📄 Getting Started

This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.

Every API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.

The API must not be abused and should be used within acceptable limits.

To start using this API, you will need not create or access an existing Segnivo account to obtain your API key (retrievable from your account settings).

You must use a valid API Key to send requests to the API endpoints.
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key or with details in the message key.

🔖 Need some help?

In case you have questions or need clarity with interacting with some endpoints feel free to create a support ticket on your account or you can send an email (developers@segnivo.com) directly and we would be happy to help.

Authentication

As noted earlier, this API uses API keys for authentication. You can generate a Segnivo API key in the API section of your account settings.

You must include an API key in each request to this API with the X-API-KEY request header.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

API access rate limits apply on a per-API endpoint basis in unit time. The limit is 10k requests per hour for most endpoints and 1m requests per hour for transactional/relay email-sending endpoints. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code or HTTP 403 if sending credits have been exhausted.

503 response

An HTTP 503 response from our servers may indicate there is an unexpected spike in API access traffic, while this rarely happens, we ensure the server is usually operational within the next two to five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support (developers@segnivo.com).

Request headers

To make a successful request, some or all of the following headers must be passed with the request.

🔖 Note with example requests and code snippets

If/when you use the code snippets used as example requests, remember to calculate and add the Content-Length header. Some request libraries, frameworks, and tools automatically add this header for you while a few do not. Kindly check and ensure yours does or add it yourself.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/segnivo-sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: apiKeyAuth
$config = Segnivo\SDK\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Segnivo\SDK\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');


$apiInstance = new Segnivo\SDK\Api\EmailAddressVerificationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = array('key' => new \stdClass); // object

try {
    $result = $apiInstance->validateEmailPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmailAddressVerificationApi->validateEmailPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.segnivo.com/v1

Models

Authorization

Authentication schemes defined for the API:

apiKeyAuth

Type: API key
API key parameter name: X-API-KEY
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
- Package version: 1.7.6
- Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

segnivo / php-sdk

Maintainers

Details