PHPackages factura-com/factura-com-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. factura-com/factura-com-sdk ActiveLibrary[API Development](/categories/api) factura-com/factura-com-sdk =========================== 03[1 PRs](https://github.com/CodericEcosystem/factura-com-sdk/pulls)PHPCI passing Since Feb 23Pushed 1y ago1 watchersCompare [ Source](https://github.com/CodericEcosystem/factura-com-sdk)[ Packagist](https://packagist.org/packages/factura-com/factura-com-sdk)[ RSS](/packages/factura-com-factura-com-sdk/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (2)Used By (0) SwaggerClient-php ================= [](#swaggerclient-php) Introducción Te invitamos a utilizar la documentación de nuestra API. Es un recurso completo y fácil de entender que te guiará en el uso de nuestras funcionalidades. Si tienes alguna pregunta, nuestro equipo de soporte técnico está disponible para ayudarte. Aprovecha las ventajas de nuestra API para automatizar tus procesos de facturación y agilizar tus operaciones comerciales. ¡Explora nuestra documentación de API y descubre todo lo que Factura.com puede hacer por ti! Atentamente, El equipo de Factura.com --- # Autenticación de API El API de factura.com utiliza autenticación básica la cual requiere los siguientes datos de acceso: - \\\[API\_KEY\\\] - \\\[SECRET\_KEY\\\] La autenticación del API requiere incluir en el header los datos de autorización junto a el **F-PLUGIN** cuyo valor siempre será: **9d4095c8f7ed5785cb14c0e3b033eeb8252416ed** Los métodos disponibles en el workspace ya cuentan con un header de ejemplo en donde contienen los datos antes mencionados, en el entorno existen dos variables en donde podemos ingresar nuestras llaves para usarlas de forma mas sencilla estas variables se encuentran en: - Factura.com Workspace Publico **→** Variables Solo sustituye el texto **Tu API key** y **Tu Secret key** por los valores correspondientes # Genera tu API Key Puedes usar el API de factura.com en dos modos, sandbox y producción. El API Key y el Secret Key son diferentes para cada modo. Para obtener tus llaves de acceso deber seguir los siguientes pasos: - Iniciar sesión (Si es en producción en https://factura.com/, si es en sandbox en http://sandbox.factura.com/ ). - En el menú lateral dirígete a Configuraciones - API - Datos de acceso . - Haz clic en el botón que se encuentra junto a cada token de acceso para copiarlo. # Errores Todas las peticiones exitosas regresan un código de estatus HTTP 204. En caso de un error, el API regresa un JSON con los parámetros que contienen la razón del error. La documentación completa y explicación de los métodos la puedes encontrar en nuestra documentación para developers en: Documentación API factura.com # Construcción de la URL A continuación se explica la estructura básica de como están compuestos los siguientes métodos para operaciones de CFDI **Host**: https://api.factura.com/ (producción) / http://sandbox.factura.com/api/ (sandbox) **Endpoint**: /v4/cfdi/list **Ejemplo**: https://api.factura.com/v4/cfdi/list ## Ejemplo: `php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, \"http://sandbox.factura.com/api/v4/cfdi/list\"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE); curl_setopt($ch, CURLOPT_HEADER, FALSE); curl_setopt($ch, CURLOPT_HTTPHEADER, array( \"Content-Type: application/json\", \"F-PLUGIN: \" . '9d4095c8f7ed5785cb14c0e3b033eeb8252416ed', \"F-Api-Key: \".'Ingresa API KEY', \"F-Secret-Key: \" .'Ingresa SECRET KEY' )); $response = curl_exec($ch); return die($response); curl_close($ch); ?> ` > <h3 >RECUERDA QUE 👀</h3> > Para probar el código de ejemplo es necesario que reemplaces el texto **Ingresa API KEY** por el API KEY de tu cuenta, e **Ingresa SECRET KEY** por el SECRET KEY correspondiente. ## Respuesta: ## Respuesta exitosa `jason { \"status\": \"success\", \"response\": \"success\", \"total\": 2479, \"per_page\": 100, \"current_page\": 1, \"last_page\": 25, \"from\": 1, \"to\": 100, \"data\": [ { \"RazonSocialReceptor\": \"Venta Al Público en General\", \"Folio\": \"F 01\", \"UID\": \"5c04c662exxxx\", \"UUID\": \"1750d757-577d-xxxx-xxxx-518b87b24a87\", \"Subtotal\": \"5.000000\", \"Descuento\": null, \"Total\": \"5.800000\", \"ReferenceClient\": 0, \"NumOrder\": null, \"Receptor\": \"XAXX010101000\", \"FechaTimbrado\": \"2018-12-03\", \"Status\": \"enviada\", \"Version\": \"3.3\" }, { \"RazonSocialReceptor\": \"Cliente ejemplo\", \"Folio\": \"F 160\", \"UID\": \"5c033ca2e4xxx\", \"UUID\": \"c25c6c99-xxx-xxx-810e-e5ae7e12eb15\", \"Subtotal\": \"10000.000000\", \"Descuento\": null, \"Total\": \"11600.000000\", \"ReferenceClient\": 15, \"NumOrder\": null, \"Receptor\": \"XAXX010101000\", \"FechaTimbrado\": \"2018-12-01\", \"Status\": \"enviada\", \"Version\": \"3.3\" } ] } ` ## Respuesta erronea `json { \"status\": \"error\", \"message\": \"La cuenta que intenta autenticarse no existe\", \"Data\": \"$2y$10$dnOV7qC7ZrD1CZitpUnTReLKtKPxG29XfwZylrEuiR0KVl18pOXXX\", \"Secret\": \"$2y$10$6ZN4aX5UExwz6HFlDSZcxOF1TGjHx8f40neE.CrXHHahyAfi8qiXXX\" } ` # Métodos disponibles: ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================== [](#introducción--te-invitamos-a-utilizar-la-documentación-de-nuestra-api-es-un---recurso-completo-y-fácil-de-entender-que-te-guiará-en-el-uso-de-nuestras---funcionalidades-si-tienes-alguna-pregunta-nuestro-equipo-de-soporte---técnico-está-disponible-para-ayudarte--aprovecha-las-ventajas-de-nuestra-api-para-automatizar-tus-procesos-de-facturación-y-agilizar-tus-operaciones-comerciales--explora-nuestra-documentación-de-api-y-descubre-todo-lo-que-facturacom-puede-hacer-por-ti--atentamente-el-equipo-de-facturacom--------autenticación-de-api--el-api-de-facturacom-utiliza-autenticación-básica-la-cual-requiere-los-siguientes-datos-de-acceso----api_key---secret_key-------la-autenticación-del-api-requiere-incluir-en-el-header-los-datos-de-autorización-junto-a-el-f-plugin-cuyo-valor-siempre-será-9d4095c8f7ed5785cb14c0e3b033eeb8252416ed--los-métodos-disponibles-en-el-workspace-ya-cuentan-con-un-header-de-ejemplo-en-donde-contienen-los-datos-antes-mencionados-en-el-entorno-existen-dos-variables-en-donde-podemos-ingresar-nuestras-llaves-para-usarlas-de-forma-mas-sencilla-estas-variables-se-encuentran-en----facturacom-workspace-publico--variables-------solo-sustituye-el-texto-tu-api-key-y-tu-secret-key-por-los-valores-correspondientes---genera-tu-api-key--puedes-usar-el-api-de-facturacom-en-dos-modos-sandbox-y-producción-el-api-key-y-el-secret-key-son-diferentes-para-cada-modo--para-obtener-tus-llaves-de-acceso-deber-seguir-los-siguientes-pasos----iniciar-sesión-si-es-en-producción-en-httpsfacturacom-si-es-en-sandbox-en-httpsandboxfacturacom----en-el-menú-lateral-dirígete-a-configuraciones---api---datos-de-acceso----haz-clic-en-el-botón-que-se-encuentra-junto-a-cada-token-de-acceso-para-copiarlo--------errores--todas-las-peticiones-exitosas-regresan-un-código-de-estatus-http-204-en-caso-de-un-error-el-api-regresa-un-json-con-los-parámetros-que-contienen-la-razón-del-error--la-documentación-completa-y-explicación-de-los-métodos-la-puedes-encontrar-en-nuestra-documentación-para-developers-en--documentación-api-facturacom---construcción-de-la-url--a-continuación-se-explica-la-estructura-básica-de-como-están-compuestos-los-siguientes-métodos-para-operaciones-de-cfdi--host-httpsapifacturacom-producción--httpsandboxfacturacomapi-sandbox---endpoint-v4cfdilist--ejemplo-httpsapifacturacomv4cfdilist---ejemplo--php-ch--curl_init-curl_setoptch-curlopt_url-httpsandboxfacturacomapiv4cfdilist-curl_setoptch-curlopt_returntransfer-true-curl_setoptch-curlopt_header-false-curl_setoptch-curlopt_httpheader-array-----content-type-applicationjson-----f-plugin---9d4095c8f7ed5785cb14c0e3b033eeb8252416ed-----f-api-key-ingresa-api-key-----f-secret-key--ingresa-secret-key--response--curl_execch-return-dieresponse-curl_closech------h3-recuerda-que-h3------para-probar-el-código-de-ejemplo-es-necesario-que-reemplaces-el-texto-ingresa-api-key-por-el-api-key-de-tu-cuenta-e-ingresa-secret-key-por-el-secret-key-correspondiente-------respuesta---respuesta-exitosa--jason----status-success---response-success---total-2479---per_page-100---current_page-1---last_page-25---from-1---to-100---data-------------razonsocialreceptor-venta-al-público-en-general-------folio-f-01-------uid-5c04c662exxxx-------uuid-1750d757-577d-xxxx-xxxx-518b87b24a87-------subtotal-5000000-------descuento-null-------total-5800000-------referenceclient-0-------numorder-null-------receptor-xaxx010101000-------fechatimbrado-2018-12-03-------status-enviada-------version-33-----------------razonsocialreceptor-cliente-ejemplo-------folio-f-160-------uid-5c033ca2e4xxx-------uuid-c25c6c99-xxx-xxx-810e-e5ae7e12eb15-------subtotal-10000000000-------descuento-null-------total-11600000000-------referenceclient-15-------numorder-null-------receptor-xaxx010101000-------fechatimbrado-2018-12-01-------status-enviada-------version-33--------------respuesta-erronea--json----status-error---message-la-cuenta-que-intenta-autenticarse-no-existe---data-2y10dnov7qc7zrd1czitpuntrelktkpxg29xfwzylreuir0kvl18poxxx---secret-2y106zn4ax5uexwz6hfldszcxof1tgjhx8f40neecrxhhahyafi8qixxx------métodos-disponibles) This PHP package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.0 - Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen Requirements ------------ [](#requirements) PHP 5.5 and later Installation & Usage ------------------------ [](#installation--usage) ### Composer [](#composer) To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: ``` { "repositories": [ { "type": "git", "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 [](#manual-installation) Download the files and include `autoload.php`: ``` require_once('/path/to/SwaggerClient-php/vendor/autoload.php'); ``` Tests ----- [](#tests) To run the unit tests: ``` composer install ./vendor/bin/phpunit ``` Getting Started --------------- [](#getting-started) Please follow the [installation procedure](#installation--usage) and then run the following: ```