giansalex/sufel-client

Sufel Php Client for Company

v1.0.0 2018-04-24 15:42 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• phpunit/phpunit: ^4.8

MIT

• Giancarlos Salas

• php
• api
• sdk
• sufel

README

Sufel API for Companies.

This PHP package is automatically generated by the Swagger Codegen project:

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer:

composer require giansalex/sufel-client

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');
$config = Sufel\Client\Configuration::getDefaultConfiguration();
// Configure your host
$config->setHost('http://domain.com/api');
// Configure API key authorization: Bearer
$config->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Sufel\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Sufel\Client\Api\CompanyApi(
    // 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 = new \Sufel\Client\Model\FilesDocument(); // \Sufel\Client\Model\FilesDocument | Archivos del documento electrónico.

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

?>

Documentation for API Endpoints

All URIs are relative to http://sufel.net/api

Class	Method	HTTP request	Description
CompanyApi	addDocument	POST /company/documents	Agrega nuevo documento.
CompanyApi	authCompany	POST /company/auth	Autentificacion de Empresa
CompanyApi	changePassword	POST /company/change-password	Cambia la contraseña de la Empresa
CompanyApi	creteCompany	POST /companies	Crea nueva Empresa
CompanyApi	darBajaDocument	PATCH /company/documents	Da de baja documento.
CompanyApi	getDocuments	GET /company/documents	Lista los documentos del emisor

Documentation For Models

• AuthToken
• Company
• CompanyCredential
• Document
• DocumentInfo
• FilesDocument
• PasswordRenew

Documentation For Authorization

AdminToken

• Type: API key
• API key parameter name: token
• Location: URL query string

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author

Giancarlos Salas
[e-mail]