hafael/autum-platform-sdk

v0.0.5 2024-02-15 20:51 UTC

This package is auto-updated.

Last update: 2024-04-15 21:09:45 UTC


README

Latest Stable Version Latest Unstable Version Total Downloads License

This library provides developers with a simple set of bindings to help you integrate Fitbank API to PHP website project.

💡 Requirements

PHP 7.3 or higher

🧩 API resources

Resource Status
User Account
Notifications
Contacts

✅ = All methods available ⌛ = Under development/testing 💻 = Awaiting contributions

📦 Installation

First time using Autum? Create your Autum account, if you don’t have one already.

  1. Download Composer if not already installed

  2. On your project directory run on the command line composer require "hafael/autum-platform-sdk"

  3. Copy the API Key and replace API_KEY with it.

That's it! Autum Platform PHP SDK has been successfully installed.

🌟 Getting Started

Simple usage looks like:

  <?php
    require_once 'vendor/autoload.php'; // You have to require the library from your Composer vendor folder

    $autumClient = new Autum\SDK\Platform\Client(
        'API_KEY', 
        'BASE_URL',
    );

    //Get authenticated user info
    $response = $autumClient->users()->getAuthenticatedUser();

    var_dump($response->json());

  ?>

📚 Documentation

Visit our Dev Site for further information regarding:

📜 License

MIT license. Copyright (c) 2023 - Rafael / Autum For more information, see the LICENSE file.