Download the PHP package r3mfr/api-dpae-php without Composer

On this page you can find all versions of the php package r3mfr/api-dpae-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of r3mfr/api-dpae-php

Informations about the package api-dpae-php

API DPAE - PHP

Cette librairie fournit un moyen simple pour utiliser l'API DPAE dpae.r3m.fr pour toute application écrite dans le language PHP.

CI

Pré-requis

PHP 7.1.0 et plus récent.

Installation

La méthode d'installation recommandée est avec Composer. Exécutez la commande suivante :

Assurez-vous que le fichier d'autoload de Composer soit bien inclus dans votre application :

Documentation

Se référer à la documentation de l'API DPAE pour avoir un aperçu complet du fonctionnement de l'API, et de son intégration dans un logiciel.

Authentification

Toute requête doit être accompagnée par un jeton JWT.

Ce jeton est créé automatiquement pour vous par la librairie PHP, en utilisant vos identifiants.

Pour obtenir vos identifiants, vous devez vous créer un compte sur API DPAE.

Stockage du jeton d'authentification

Le jeton JWT a une durée de vie limitée. Par défaut il est stocké en mémoire, et est donc redemandé à chaque requête. Cela n'est pas optimal et peut poser des problèmes de quota d'authentification.

Il est fortement conseillé de permettre le stockage du jeton JWT ailleurs qu'en mémoire, en définissant un TokenStorage. Exemple :

Soumettre une embauche

Pour effectuer une DPAE, vous devez soumettre une Embauche à l'API DPAE. Référez-vous à la documentation pour avoir le détail et le format des propriétés d'une Embauche.

Vérifier le statut d'une Embauche

Bien qu'il soit conseillé d'utiliser un Webhook pour être notifié du retour de la DPAE, il est possible d'interroger l'API DPAE manuellement.

Recevoir la notification Webhook

Il est possible d'être notifié par l'API dès qu'un accusé de réception est disponible. Il suffit de déclarer une URL de votre application en tant que webhook. Ainsi, il ne sera pas nécessaire d'interroger régulièrement l'API pour connaître le statut de vos déclarations d'embauche : c'est l'API qui notifiera votre application, en lui passant toutes les informations nécessaires au traitement de l'accusé de réception.

Vous devez donc exposer une URL de votre application. Lors de l'appel de cette URL, exécutez le code suivant :

En cas de maintenance

En cas de maintenance de votre application, vous pouvez retourner une 503. Cela permettra à l'API DPAE de retenter la notification par webhook un peu plus tard.

Utiliser un autre client HTTP

Par défaut, symfony/http-client est utilisé pour dialoguer avec API DPAE. Si vous préférez, vous pouvez utiliser un autre client HTTP implémentant \Psr\Http\Client\ClientInterface.

Contributions

Les pull request sont les bienvenues.

Tests

Codeception est utilisé pour les tests.

All versions of api-dpae-php with dependencies

PHP Build Version
Package Version
Requires php Version >=7.1.0
ext-json Version *
symfony/http-client Version ^4.4 || ^5.4 || ^6.4
nyholm/psr7-server Version ^1.0
nyholm/psr7 Version ^1.5
psr/http-client Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package r3mfr/api-dpae-php contains the following files

Loading the files please wait ....