diff --git a/README.md b/README.md index b49c603..3257c75 100644 --- a/README.md +++ b/README.md @@ -1,58 +1,177 @@ -# Afip.php -Si no queres perder tiempo ni romperte la cabeza tratando de usar los Web Services de AFIP podes utilizar esta librería que te va a ahorrar mucho tiempo, y además es de uso libre y gratuito. -### ❗❗ Cómo usar la librería -Antes de comenzar a utilizar los web services debes leer los [primeros pasos](https://github.com/afipsdk/Afip.php/wiki/Primeros-pasos) donde te enseña como instalar y usar esta librería. -### 🖨️️ Cómo usar el web service de factura electrónica + +[![Packagist][packagist-shield]](https://packagist.org/packages/afipsdk/afip.php) +[![Contributors][contributors-shield]](https://github.com/afipsdk/afip.php/graphs/contributors) +[![Closed issues][issues-shield]](https://github.com/afipsdk/afip.php/issues) +[![License][license-shield]](https://github.com/afipsdk/afip.php/blob/master/LICENSE) + + + +
+

+ + Logo + + +

Afip.php

+ +

+ Librería para conectarse a los Web Services de AFIP +
+ Explorar documentación » +
+
+ Reportar un bug +

+

+

+ Implementation +

+ + +## Tabla de contenidos + +* [Acerca del proyecto](#acerca-del-proyecto) +* [Guía de inicio](#guía-de-inicio) + * [Instalación](#instalaci%C3%B3n) + * [Como usarlo](#como-usarlo) +* [Web Services](#web-services) + * [Factura electrónica](#factura-electr%C3%B3nica) + * [Padrón alcance 4](#padr%C3%B3n-alcance-4) + * [Padrón alcance 5](#padr%C3%B3n-alcance-5) + * [Padrón alcance 10](#padr%C3%B3n-alcance-10) + * [Padrón alcance 13](#padr%C3%B3n-alcance-13) +* [Migración](#migraci%C3%B3n) +* [Proyectos relacionados](#proyectos-relacionados) +* [Afip SDK PRO 🚀](#afip-sdk-pro-) +* [Contribuir](#contribuir) +* [Licencia](#licencia) +* [Contacto](#contacto) + + + + +## Acerca del proyecto + +Esta librería fue creada con la intención de ayudar a los programadores a usar los Web Services de AFIP sin romperse la cabeza ni perder tiempo tratando de entender la complicada documentación que AFIP provee. Ademas forma parte de [Afip SDK](https://afipsdk.github.io/). + + + +## Guía de inicio + +### Instalación + +#### Via Composer + +``` +composer require afipsdk/afip.php +``` + +#### Via Manual +1. Clonarlo con `git clone` o descargar el repositorio desde [aqui](https://github.com/afipsdk/afip.php/archive/0.5.3.zip "Descargar repositorio"). +2. Copiar el contenido de la carpeta *res* a tu aplicación. + +**Importante** +* Remplazar `Afip_res/cert` por tu certificado provisto por AFIP y `Afip_res/key` por la clave generada. +* Procuren que la carpeta `Afip_res` no sea accesible desde internet ya que allí se guardara toda la informacion para acceder a los web services, **ademas esta carpeta deberá tener permisos de escritura**. + +Ir a http://www.afip.gob.ar/ws/documentacion/certificados.asp para obtener mas información de como generar la clave y certificado. + +Si no pueden seguir la complicada documentación de AFIP para obtener el certificado pueden obtener [Afip SDK PRO](#afip-sdk-pro-) donde se explica cómo obtener los certificados fácilmente. + +### Como usarlo + +Si lo instalaste manualmente lo primero es incluir el SDK en tu aplicación +````php +include 'Afip.php'; +```` + +Luego creamos una instancia de la clase Afip pasandole un Array como parámetro. +````php +$afip = new Afip(array('CUIT' => 20111111112)); +```` + + +Para más información acerca de los parámetros que se le puede pasar a la instancia new `Afip()` consulte sección [Primeros pasos](https://github.com/afipsdk/afip.php/wiki/Primeros-pasos#como-usarlo) de la documentación + +Una vez realizado esto podemos comenzar a usar el SDK con los Web Services disponibles + + + +## Web Services + +Si necesitas más información de cómo utilizar algún web service echa un vistazo a la [documentación completa de afip.php](https://github.com/afipsdk/afip.php/wiki) + +**Además si necesitas usar otro web service que aún no está disponible aquí podes utilizar esta librería como base para que se te haga más fácil, pronto haremos un tutorial explicando paso a paso como hacerlo, pero por el momento te recomendamos comenzar haciendo una copia y modificando el código de [consulta al padrón alcance 5](https://github.com/afipsdk/afip.php/blob/master/src/Afip_res/Class/RegisterScopeFive.php)** + +### Factura electrónica Podes encontrar la documentación necesaria para utilizar la [facturación electrónica](https://github.com/afipsdk/afip.php/wiki/Facturaci%C3%B3n-Electr%C3%B3nica) 👈 aquí -### Cómo usar el web service de padrón alcance 4 (A4) +### Padrón alcance 4 El Servicio Web de Consulta de Padrón denominado A4 ha quedado limitado para Organismos Públicos, si lo necesitas puedes leer la documentación de [consulta al padrón de AFIP alcance 4](https://github.com/afipsdk/afip.php/wiki/Consulta-al-padron-de-AFIP-alcance-4) -### Cómo usar el web service de padrón alcance 5 (A5) +### Padrón alcance 5 Quienes usaban el padrón A4 pueden utilizar este padrón en modo de remplazo, si queres saber cómo echa un vistazo a la documentación de [consulta al padrón de AFIP alcance 5](https://github.com/afipsdk/afip.php/wiki/Consulta-al-padron-de-AFIP-alcance-5) -### Cómo usar el web service de padrón alcance 10 (A10) +### Padrón alcance 10 Si tenes que utilizar este web service también está disponible dentro de la librería, su documentación se encuentra en [consulta al padrón de AFIP alcance 10](https://github.com/afipsdk/afip.php/wiki/Consulta-al-padron-de-AFIP-alcance-10) -### Cómo usar el web service de padrón alcance 13 (A13) +### Padrón alcance 13 Si debes consultar por el CUIT de una persona física tendrás que utilizar este web service, su documentación se encuentra disponible en la wiki de [consulta al padrón de AFIP alcance 13](https://github.com/AfipSDK/afip.php/wiki/Consulta-al-padron-de-AFIP-alcance-13) -### ¿Necesitas migrar de versión de la librería? + + +### Migración +¿Necesitas migrar de versión de la librería? + Pueden encontrar el tutorial correspondiente aquí 👇 - [Migrar de v0.1 a v0.5](https://github.com/afipsdk/afip.php/wiki/Migrar-de-v0.1-a-v0.5) -Si necesitas más información de cómo utilizar algún web service echa un vistazo a la [documentación completa de afip.php](https://github.com/afipsdk/afip.php/wiki) -**Además si necesitas usar otro web service que aún no está disponible aquí podes utilizar esta librería como base para que se te haga más fácil, pronto haremos un tutorial explicando paso a paso como hacerlo, pero por el momento te recomendamos comenzar haciendo una copia y modificando el código de [consulta al padrón alcance 5](https://github.com/afipsdk/afip.php/blob/master/src/Afip_res/Class/RegisterScopeFive.php)** - -### Proyectos Relacionados 🤝 + +### Proyectos relacionados #### Bundle para Symfony Si necesitas utilizar los web services de Afip en _Symfony_ podes utilizar este [bundle](https://github.com/gonzakpo/afip) -# Afip SDK PRO ✔️ -¿Quieres ahorrar aún más tiempo? Prueba la versión PRO de Afip SDK + +### Afip SDK PRO 🚀 + +¿Necesitas ayuda? Afip SDK PRO incluye soporte personalizado por 3 meses (o más) donde te ayudaremos integrar los web services de Afip con tu aplicación, y una amplia documentación con ejemplos, tutoriales, implementación en Frameworks y mucho más. -Ejemplos listos para usar, implementación en Frameworks, solución a errores frecuentes, tutoriales y más… +**[Saber más](https://afipsdk.github.io/pro.html)** -[Saber más](https://afipsdk.github.io/pro.html) + +### Contribuir +Las contribuciones son las que hacen que la comunidad de código abierto sea un lugar increíble para aprender, inspirar y crear. Cualquier contribución que hagas es **muy apreciada**. +1. Haz un Fork +2. Crea el Branch de tu Feature (`git checkout -b feature/AmazingFeature`) +3. Agrega tus cambios (`git commit -m 'Add some AmazingFeature`) +4. Haz un Push al Branch (`git push origin feature/AmazingFeature`) +5. Abre un Pull Request -## Acerca de -Esta librería fue programada para facilitar la integración con los Web Services de la AFIP y forma parte de [Afip SDK](https://afipsdk.github.io/). -Si queres contribuir al proyecto sentite libre de hacer un Pull Request al repositorio. + +### Licencia +Distribuido bajo la licencia MIT. Vea `LICENSE` para más información. -## Dudas y ayuda -Si tienen alguna consulta o duda pueden resolverla en el [foro de la librería](https://groups.google.com/forum/#!forum/afip-php) -## 📧 Contacto -afipsdk@gmail.com + +### Contacto +Afip SDK - afipsdk@gmail.com + +Link del proyecto: [https://github.com/afipsdk/afip.php](https://github.com/afipsdk/afip.php) _Este software y sus desarrolladores no tienen ninguna relación con la AFIP._ + +[packagist-shield]: https://img.shields.io/packagist/dt/afipsdk/afip.php.svg??logo=php&?logoColor=white +[contributors-shield]: https://img.shields.io/github/contributors/afipsdk/afip.php.svg?color=orange +[issues-shield]: https://img.shields.io/github/issues-closed-raw/afipsdk/afip.php.svg?color=blueviolet +[license-shield]: https://img.shields.io/github/license/afipsdk/afip.php.svg?color=blue +