What's the LPGP API? - GiullianoRossi1987/lpgp-api GitHub Wiki

What's it ?

This is a server API, used to send main data to the clients of a specific LPGP key proprietary. Those clients and signatures (keys) can only be created accessing the main website main LPGP site repository. The clients have specific accesses to the LPGP data provided by this application.

Clients

The clients are used to provide and authenticate the access of a instance of the proprietary in other environment, they can be used to authenticate a signature key in a proprietary's software or sub-system of the LPGP. There're two kinds, or types, of clients

  • Normal

The standard type of a client. Which can only authenticate a signature key or other client's key in external environment. That's the more common kind of client used by programmers, because it's simple to use and grant a security to the data.

  • Root

This type is used for clients that must be able to change data about their proprietary or his keys and clients, it's normally used in automation of some processes the proprietary is used to do in the LPGP website.

How to use

The basic use of the API requires the client key, a string with the LPGP generated key for the client. The client key and the signature key can be accessed in the LPGP website. The URL request in any application must have two obligatory parameters and use the GET method HTTP request, it can be used by AJAX or the XMLHttpRequest JavaScript's class, the client-key and if it's LPGP encoded, if it's LPGP encoded it must look like the content of a .lpgp file, being this one a boolean string parsed type:

$.get({ url: "https://api.lpgpofficial.com/client/get.php", data: { "client-key": "<your-key-here", "lpgp_mode": "t/f" } });