dot-env-it/laravel-api-integrator

Package to simplify third-party api integrations. Make API calls like they are part of your code with this package. No need to remember base url or path of any API.

v1.3.0 2023-11-12 07:20 UTC

Requires

• php: ^8.1 || ^8.2
• guzzlehttp/guzzle: ^7.8
• symfony/yaml: ^6.3

Requires (Dev)

• laravel/pint: ^1.13
• orchestra/testbench: ^8.11
• pestphp/pest: ^2.19
• pestphp/pest-plugin-type-coverage: ^2.2
• roave/security-advisories: dev-latest

MIT

• Jagdish Patel

README

Package to simplify third-party api integrations. Make API calls like they are part of your code with this package. No need to remember base url or path of any API. Just call it like Integration::for('api-provider')->getSomethingCool()->json();

Become a sponsor

Your support allows me to keep this package free, up-to-date and maintainable. Alternatively, you can spread the word!

Installation

composer require dot-env-it/laravel-api-integrator

Run install command to publish config file and yaml file

php artisan api-integrator:install

This command will create api-integrator.yaml file at root of project and api-integrator.php file at config folder

Sample api-integrator.yaml file

integrations:
  github:
    url: 'https://api.github.com/'
    auth:
      type: Bearer
      value: !config 'api-integrator.token.github'
      name: 'Authorization'

  example:
    url: 'https://api.example.com'
    auth:
      type: Header
      token: !config 'api-integrator.token.example'
      name: 'X-API-KEY'

You can pass config variables to yaml file using !config tag

USAGE

use DotEnvIt\ApiIntegrator\Facades\Integration;

//api url https://api.github.com/foo
Integration::for('github')->get('foo')->json();

//api url https://api.example.com/foo
Integration::for('example')->get('foo')->json();

This package also provides a magic method for each http method

use DotEnvIt\ApiIntegrator\Facades\Integration;

//api url https://api.example.com/foo
Integration::for('example')->getFoo()->json();

//api url https://api.example.com/foo with dynamic token
Integration::for('example')->withToken('new-token')->getFoo()->json();

//api url https://api.example.com/foo with dynamic header
Integration::for('example')->withHeader('X-CUSTOM-HEADER', 'CUSTOM')->withHeader('X-CUSTOM-HEADER-2', 'CUSTOM-2')->getFoo()->json();

//api url https://api.example.com/foo with headers array
Integration::for('example')->withHeaders(['X-CUSTOM-HEADER' => 'CUSTOM', 'X-CUSTOM-HEADER-2' => 'CUSTOM-2'])->getFoo()->json();

//api url https://api.example.com/foo/1
Integration::for('example')->getFoo_id(['id' => 1])->json();

//api url https://api.example.com/foo/1/bar/2
Integration::for('example')->getFoo_foo_id_bar_bar_id(['foo_id' => 1, 'bar_id' => 2])->json();

//api url https://api.example.com/foo/1?foo=bar&bar=baz
Integration::for('example')->getFoo_id(['id' => 1, 'foo' => 'bar', 'bar' => 'baz'])->json();

//POST api url https://api.example.com/foo/1/bar/2/baz
Integration::for('example')->postFoo_foo_id_bar_bar_id_baz(['foo_id' => 1, 'bar_id' => 2])->json();

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Credits

• Jagdish-J-P
• dot-env-it
• Just Steve King
• All Contributors

License

The MIT License (MIT). Please see License File for more information.