Skip to content
This repository was archived by the owner on Sep 2, 2021. It is now read-only.

Commit 8d1e95c

Browse files
change docs
1 parent b457a10 commit 8d1e95c

16 files changed

+48
-16769
lines changed
Binary file not shown.

api/src/main/resources/META-INF/resources/assets/images/logo-navbar.svg

Lines changed: 1 addition & 16 deletions
Loading

api/src/main/resources/META-INF/resources/assets/styles/patternfly.css

Lines changed: 0 additions & 16147 deletions
This file was deleted.

api/src/main/resources/META-INF/resources/index.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
<header class="pf-c-page__header">
2020
<div class="pf-c-page__header-brand">
2121
<a class="pf-c-page__header-brand-link">
22-
<img class="pf-c-brand" src="assets/images/logo-navbar.svg" alt="PatternFly logo"/>
22+
<img class="pf-c-brand" src="assets/images/logo-navbar.svg" alt="PatternFly logo" style="height: 40px;"/>
2323
</a>
2424
</div>
2525
<div class="pf-c-page__header-nav">
@@ -45,14 +45,14 @@
4545
<div class="pf-c-empty-state">
4646
<div class="pf-c-empty-state__content">
4747
<i class="fas fa-cubes pf-c-empty-state__icon" aria-hidden="true"></i>
48-
<h1 class="pf-c-title pf-m-lg">Welcome to XML Builder</h1>
48+
<h1 class="pf-c-title pf-m-lg">Welcome to XBuilder Server</h1>
4949
<div class="pf-c-empty-state__body">
50-
<p>XML Builder is a microservice that can create XML files based on UBL standards.</p>
51-
<p>To start using XML Builder you can visit the API Documentation and start using our REST endpoints.</p>
50+
<p>XBuilder Server is a microservice that can create XML files based on UBL standards.</p>
51+
<p>To start using XBuilder Server you can visit the API Documentation and start using our REST endpoints.</p>
5252
</div>
5353
<a class="pf-c-button pf-m-primary" href="https://app.swaggerhub.com/apis-docs/project-openubl/xbuilder-server">API Documentation</a>
5454
<div class="pf-c-empty-state__secondary">
55-
<a class="pf-c-button pf-m-link" href="https://project-openubl.github.io">Documentation</a>
55+
<a class="pf-c-button pf-m-link" href="https://project-openubl.github.io/xbuilder-server-docs/">Documentation</a>
5656
<a class="pf-c-button pf-m-link" href="https://github.com/project-openubl/xbuilder-server">Source code</a>
5757
<a class="pf-c-button pf-m-link" href="https://github.com/project-openubl/xbuilder">Library</a>
5858
<a class="pf-c-button pf-m-link" href="mailto:[email protected]">Mailing list</a>

docusaurus/docs/example.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,40 @@ curl -X POST \
3838
}' \
3939
http://localhost:8080/api/documents/invoice/create
4040
```
41+
42+
## Sign XML
43+
44+
For creating an XML and also sign it you need to provide 3 things:
45+
46+
- **JSON input** - The body of the request which contains info about the document you are about to create.
47+
- **X-OPENBUL-PRIVATEKEY** - The header which contains the PEM encoded version of your private key.
48+
- **X-OPENUBL-CERTIFICATEKEY** - The header which contains the PEM encoded version of your certificate.
49+
50+
```shell script
51+
curl -X POST \
52+
-H "Content-Type: application/json" \
53+
-H "X-OPENBUL-PRIVATEKEY: MIIEowIBAAKCAQEArhO3H48lGkRNcPNhA6uTd804NnMxBkXKKTgR8DldX8vTmrf0JqNGMLxUlqSG1KlRelHQXvIz7GWO0NgE0DZ9eMEULS7S8YMuj6RZFCudDb/aasxHyCvjVfdKJUF4BIPPKN2dvjFBAQz4fI/3/PceptIqzwzl+8SryXEbJgAUmjaS2POE65RePRIINOV1Vi7lwvLzH0Zl1sr+oytOnXAI1YRlKZhgcS5v5XeX/qfRpbIQdqxcloVAQX/voN8QsLT6chZr/gEZbUnDs2HD286/Xzg27Rw8Bwy7HIbhhKYPK2TsFanpMhsTVtC3gxp6umLb3Fuala7RBC76nDZC9A+95QIDAQABAoIBABhHrbIcMCuivT504+I0K0R5fk6x8HOUhmcLaA0eozR6ZJBe+hHtkhu4GQBOAHRnDXNHOA4WMEHXxHzCtKEqCIQwQhUvQ8Ll7jegz7/teWFykg91YMm9vV6/ODtMD2Zp0Bo+FwNxMUTpPzt4hTlmaoMQK2JnxShBvUhCm2vIdRcxLHV63HjRWqHu98vKYxQ5ByQX3nVBP757zRI2rhC5g0yzQucGj2GMeD3t8W/NozNaUx9qXq2YaqhIYfhbzKZH41ZeIpE0Au7aNS4WBTpWkO1patCpSZHhTV9RIbBCG7al0ukLs3FfbWoHCAJAHUyuEvG4htSb0WqudlJn/rPNdP0CgYEA4SK8NgON4wvdi42dr43NdcOVbWes4HM4M8f1pi7W9RSracuAXj7oeyirKPnUMJchRNOlF/aTghbgtbgAYBFxYYfFbc12BURiAgo6firu6ILD7696V/uxiQPSg/chVrBkN1rYYf1sTgcJB9N7uuiBQZAh8NJWJNvviPVxNfFhoO8CgYEAxfEMCnEBiiOiKi72eclGGAAQr/JAdoaCXZPi1lmbAkWULtyqoo3MzyuyJ3GDwb1j8e2JqPEvqAW8w993Z5vqk/N9MA7rlSE6UPxTHs8ZKNWcdci0rReurG+evrGRRJmKuvqK0/7Nqr/f039VuRqvgtWxJeFoBNZVpwGG/LeCJmsCgYAVcjyhnJcQkNnK6HOj/Isc88OxR1YFj5REAoFZEk8xy4VEr7kLwUxeJxKe9aWL92mY59xrOvb0Rn+jb+LBRAgb9VYOTqs2dzwq25SU3jwh9Ar8MyghZ32TAsU0Av+vBWCWkVXZh82gZTUsBK5dsLZXa4aALVk9a6IW1uKw88yMCwKBgFk3e2jdZIdB5l7DCh78ZFZ++QaE1x9VIz9QX8ajXqWYfODeXx6jcTPTixoSJQPW/ExX91spUoSWCW3ztBsEAKgs8DkQEIkIEAPepwxU5g8ssLe5/g2ihf181f03hbV4yznZoWdKCqMyloz6cMXczEzZSl47iancfYCnxJL1l3j/AoGBAIQDUua/Ia2LLJE24kamiLmdtECHsXg/Wrp++YaGc2btHblAN5TNQfy3S4yvQIOzaVp7AQMXq/AUdua1YcLS1Op/CsocgVMzpckZ7FVS8BFuQnQx8ltnAcqbnCo6UzUdOPKNRw2EDyk9yK83wEtvkvlHOVdRsOlYN5ZSrkq1X92A" \
54+
-H "X-OPENUBL-CERTIFICATEKEY: MIIE+DCCA+CgAwIBAgIJALURz7AYmJ5+MA0GCSqGSIb3DQEBBQUAMIIBDTEbMBkGCgmSJomT8ixkARkWC0xMQU1BLlBFIFNBMQswCQYDVQQGEwJQRTENMAsGA1UECAwETElNQTENMAsGA1UEBwwETElNQTEYMBYGA1UECgwPVFUgRU1QUkVTQSBTLkEuMUUwQwYDVQQLDDxETkkgOTk5OTk5OSBSVUMgMTA0Njc3OTM1NDkgLSBDRVJUSUZJQ0FETyBQQVJBIERFTU9TVFJBQ0nDk04xRDBCBgNVBAMMO05PTUJSRSBSRVBSRVNFTlRBTlRFIExFR0FMIC0gQ0VSVElGSUNBRE8gUEFSQSBERU1PU1RSQUNJw5NOMRwwGgYJKoZIhvcNAQkBFg1kZW1vQGxsYW1hLnBlMB4XDTE5MTEwODEyNTY1MFoXDTIxMTEwNzEyNTY1MFowggENMRswGQYKCZImiZPyLGQBGRYLTExBTUEuUEUgU0ExCzAJBgNVBAYTAlBFMQ0wCwYDVQQIDARMSU1BMQ0wCwYDVQQHDARMSU1BMRgwFgYDVQQKDA9UVSBFTVBSRVNBIFMuQS4xRTBDBgNVBAsMPEROSSA5OTk5OTk5IFJVQyAxMDQ2Nzc5MzU0OSAtIENFUlRJRklDQURPIFBBUkEgREVNT1NUUkFDScOTTjFEMEIGA1UEAww7Tk9NQlJFIFJFUFJFU0VOVEFOVEUgTEVHQUwgLSBDRVJUSUZJQ0FETyBQQVJBIERFTU9TVFJBQ0nDk04xHDAaBgkqhkiG9w0BCQEWDWRlbW9AbGxhbWEucGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCuE7cfjyUaRE1w82EDq5N3zTg2czEGRcopOBHwOV1fy9Oat/Qmo0YwvFSWpIbUqVF6UdBe8jPsZY7Q2ATQNn14wRQtLtLxgy6PpFkUK50Nv9pqzEfIK+NV90olQXgEg88o3Z2+MUEBDPh8j/f89x6m0irPDOX7xKvJcRsmABSaNpLY84TrlF49Egg05XVWLuXC8vMfRmXWyv6jK06dcAjVhGUpmGBxLm/ld5f+p9GlshB2rFyWhUBBf++g3xCwtPpyFmv+ARltScOzYcPbzr9fODbtHDwHDLschuGEpg8rZOwVqekyGxNW0LeDGnq6YtvcW5qVrtEELvqcNkL0D73lAgMBAAGjVzBVMB0GA1UdDgQWBBTe18LHVKkeRrWs3Bxp1ikK50l96jAfBgNVHSMEGDAWgBTe18LHVKkeRrWs3Bxp1ikK50l96jATBgNVHSUEDDAKBggrBgEFBQcDATANBgkqhkiG9w0BAQUFAAOCAQEASBWcP4AiqUUZSG2/Z3RU3BgvOVV3if8xYAaZT99n5PsvyBiZ3Gh6VpAW9ezoe25ZNSqGMmGfq+R4mEuiqK4h6jDJp0fN47IwRhWjttB9dwpxIDEkWW7zPdueGx+BY8EuyfNDWR/C7GPfu6azSHiapzeKC57AAZ8xo8kDdhXxDy8hTqNGolkqnc6QutW8cYPeonqyhi2THN163lZ3Cx5OV8vGFQ3ou2msF0klY9qXopI9i8wQjEeOG6bCvVxdID9ZjTbuGbO9pAN9hH7hZ41XEG/CspSWbFf1/Wbnlfusne9v9NgRj0MM+LAHM7AO5/7j1XwRq4x+U9TSVPgpoU9l5Q==" \
55+
-d '{
56+
"serie": "F001",
57+
"numero": 1,
58+
"proveedor": {
59+
"ruc": "12345678912",
60+
"razonSocial": "Project OpenUBL"
61+
},
62+
"cliente": {
63+
"tipoDocumentoIdentidad": "RUC",
64+
"numeroDocumentoIdentidad": "12312312312",
65+
"nombre": "Nombre de mi cliente"
66+
},
67+
"detalle": [
68+
{
69+
"descripcion": "Nombre de producto o servicio",
70+
"precioUnitario": 1,
71+
"cantidad": 1,
72+
"tipoIgv": "GRAVADO_OPERACION_ONEROSA"
73+
}
74+
]
75+
}' \
76+
http://localhost:8080/api/documents/invoice/create
77+
```

docusaurus/docs/peru_creditnote.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

docusaurus/docs/peru_debitnote.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

docusaurus/docs/peru_icb.md

Lines changed: 0 additions & 69 deletions
This file was deleted.

docusaurus/docs/peru_igv.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

docusaurus/docs/peru_invoice.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)