Skip to content

Commit

Permalink
api: docs, add api endpoints URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
jordipainan authored and p4u committed Sep 3, 2024
1 parent b5a9e14 commit 86c7f82
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion api/docs/descriptions/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@

The Vocdoni API is a REST API that substitutes the previous RPCs in order to make it easier for developers/integrators to build on top of the voting protocol. This API facilitates the creation of voting processes with Vocdoni, without the hassle of integrating with a complex distributed stack with blockchain components. The API allows integrators to perform all the features enabled by the Vocdoni voting protocol, such as creating accounts, organizations, voting processes, and censuses, as well as casting votes. The API is designed to abstract away the complexity of the Vocdoni protocol as much as possible, offering a simple and straightforward way to performing these actions.
The Vocdoni API is a REST API that substitutes the previous RPCs in order to make it easier for developers/integrators to build on top of the voting protocol. This API facilitates the creation of voting processes with Vocdoni, without the hassle of integrating with a complex distributed stack with blockchain components. The API allows integrators to perform all the features enabled by the Vocdoni voting protocol, such as creating accounts, organizations, voting processes, and censuses, as well as casting votes. The API is designed to abstract away the complexity of the Vocdoni protocol as much as possible, offering a simple and straightforward way to performing these actions.

Vocdoni API URLs:

- **Production**: https://api.vocdoni.io/v2
- **Staging**: https://api-stg.vocdoni.net/v2
- **Development**: https://api-dev.vocdoni.net/v2

The API contains the following endpoints:

Expand Down

0 comments on commit 86c7f82

Please sign in to comment.