Skip to content

Commit 5dc22d1

Browse files
committed
Update README.md
1 parent 21ad44e commit 5dc22d1

File tree

1 file changed

+144
-0
lines changed

1 file changed

+144
-0
lines changed

README.md

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,144 @@
1+
2+
3+
<!-- PROJECT SHIELDS -->
4+
[![Contributors][contributors-shield]](https://github.com/afipsdk/afip.js/graphs/contributors)
5+
[![Closed issues][issues-shield]](https://github.com/afipsdk/afip.js/issues)
6+
[![License][license-shield]](https://github.com/afipsdk/afip.js/blob/master/LICENSE)
7+
8+
9+
<!-- PROJECT LOGO -->
10+
<br />
11+
<p align="center">
12+
<a href="https://github.com/afipsdk/afip.js">
13+
<img src="https://github.com/afipsdk/afipsdk.github.io/blob/master/images/logo-colored.png" alt="Logo" width="130" height="130">
14+
</a>
15+
16+
<h3 align="center">Afip.js</h3>
17+
18+
<p align="center">
19+
Librería para conectarse a los Web Services de AFIP
20+
<br />
21+
<a href="https://github.com/afipsdk/afip.js/wiki"><strong>Explorar documentación »</strong></a>
22+
<br />
23+
<br />
24+
<a href="https://github.com/afipsdk/afip.js/issues">Reportar un bug</a>
25+
</p>
26+
</p>
27+
<p align="center">
28+
<img src="https://github.com/afipsdk/afipsdk.github.io/blob/master/images/implementation.png" alt="Implementation">
29+
</p>
30+
31+
<!-- TABLE OF CONTENTS -->
32+
## Tabla de contenidos
33+
34+
* [Acerca del proyecto](#acerca-del-proyecto)
35+
* [Guía de inicio](#guía-de-inicio)
36+
* [Instalación](#instalaci%C3%B3n)
37+
* [Como usarlo](#como-usarlo)
38+
* [Web Services](#web-services)
39+
* [Factura electrónica](#factura-electr%C3%B3nica)
40+
* [Padrón alcance 4](#padr%C3%B3n-alcance-4)
41+
* [Padrón alcance 5](#padr%C3%B3n-alcance-5)
42+
* [Padrón alcance 10](#padr%C3%B3n-alcance-10)
43+
* [Padrón alcance 13](#padr%C3%B3n-alcance-13)
44+
* [Migración](#migraci%C3%B3n)
45+
* [Proyectos relacionados](#proyectos-relacionados)
46+
* [Contribuir](#contribuir)
47+
* [Licencia](#licencia)
48+
* [Contacto](#contacto)
49+
50+
51+
52+
<!-- ABOUT THE PROJECT -->
53+
## Acerca del proyecto
54+
55+
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/).
56+
57+
58+
<!-- START GUIDE -->
59+
## Guía de inicio
60+
61+
### Instalación
62+
#### Via npm
63+
64+
```
65+
npm install --save afip.js
66+
```
67+
68+
#### Via Yarn
69+
70+
```
71+
yarn add afip.js
72+
```
73+
74+
**Siguiente paso**
75+
* Remplazar *node_modules/afip.js/Afip_res/cert* por tu certificado provisto por AFIP y *node_modules/afip.js/Afip_res/key* por la clave generada.
76+
* La carpeta *Afip_res* deberá tener permisos de escritura.
77+
78+
Ir a http://www.afip.gob.ar/ws/documentacion/certificados.asp para obtener mas información de como generar la clave y certificado
79+
80+
# Como usarlo
81+
82+
Lo primero es incluir el SDK en tu aplicación
83+
````js
84+
const Afip = require('afip.js');
85+
````
86+
87+
Luego creamos una instancia de la clase Afip pasandole un Objeto como parámetro.
88+
````js
89+
const afip = new Afip({ CUIT: 20111111112 });
90+
````
91+
92+
93+
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.js/wiki/Primeros-pasos#como-usarlo) de la documentación
94+
95+
Una vez realizado esto podemos comenzar a usar el SDK con los Web Services disponibles
96+
97+
98+
<!-- WEB SERVICES -->
99+
## Web Services
100+
101+
Si necesitas más información de cómo utilizar algún web service echa un vistazo a la [documentación completa de afip.js](https://github.com/afipsdk/afip.js/wiki)
102+
103+
**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.js/blob/master/src/Class/RegisterScopeFive.js)**
104+
105+
### Factura electrónica
106+
Podes encontrar la documentación necesaria para utilizar la [facturación electrónica](https://github.com/afipsdk/afip.js/wiki/Facturaci%C3%B3n-Electr%C3%B3nica) 👈 aquí
107+
108+
### Padrón alcance 4
109+
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.js/wiki/Consulta-al-padron-de-AFIP-alcance-4)
110+
111+
### Padrón alcance 5
112+
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.js/wiki/Consulta-al-padron-de-AFIP-alcance-5)
113+
114+
### Padrón alcance 10
115+
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.js/wiki/Consulta-al-padron-de-AFIP-alcance-10)
116+
117+
### Padrón alcance 13
118+
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.js/wiki/Consulta-al-padron-de-AFIP-alcance-13)
119+
120+
<!-- RELATED PROJECTS-->
121+
### Proyectos relacionados
122+
123+
#### Libreria para PHP
124+
Si necesitas acceder los web services de AFIP en **PHP** podes utilizar [Afip.php](https://github.com/afipsdk/afip.php)
125+
126+
<!-- LICENCE -->
127+
### Licencia
128+
Distribuido bajo la licencia MIT. Vea `LICENSE` para más información.
129+
130+
131+
<!-- CONTACT -->
132+
### Contacto
133+
134+
135+
Link del proyecto: [https://github.com/afipsdk/afip.js](https://github.com/afipsdk/afip.js)
136+
137+
138+
_Este software y sus desarrolladores no tienen ninguna relación con la AFIP._
139+
140+
<!-- MARKDOWN LINKS & IMAGES -->
141+
[contributors-shield]: https://img.shields.io/github/contributors/afipsdk/afip.js.svg?color=orange
142+
[issues-shield]: https://img.shields.io/github/issues-closed-raw/afipsdk/afip.js.svg?color=blueviolet
143+
[license-shield]: https://img.shields.io/github/license/afipsdk/afip.js.svg?color=blue
144+

0 commit comments

Comments
 (0)