Laravel API Reference

Laravel API Reference

Constructor

Magic

The Magic Laravel SDK allows you to specify your own API secret key and HTTP request strategy when your application is interacting with the Magic API via the .env file

Add the following variables in your .env file to get the most out of Magic Constructor under the hood.

MAGIC_SECRET_API_KEY=sk_XXXX_XXXXXXXXXXXXXXXX MAGIC_RETRIES=3 MAGIC_TIMEOUT=10 MAGIC_BACKOFF_FACTOR=0.02

Variables

  • MAGIC_SECRET_API_KEY: Your API secret Key retrieved from the Magic Dashboard.
  • MAGIC_RETRIES: Total number of retries to allow.
  • MAGIC_TIMEOUT: A period of time the request is going to wait for a response.
  • MAGIC_BACKOFF_FACTOR: A backoff factor to apply between retry attempts.

Token Resource

The token resource and its methods are accessible on the Magic instance by the token attribute. It provides methods to interact with the DID Token.

note

The token resource does not make any API calls to the Magic server.

use Magic; Magic::token()->validate('<did_token>'); Magic::token()->get_issuer('<did_token>'); Magic::token()->get_public_address('<did_token>'); Magic::token()->decode('<did_token>');

validate

Validates a DID token.

token.validate(did_token)
Arguments

did_token (str): A DID Token generated by a Magic user on the client-side.

Raises

DIDTokenException if the given DID Token is invalid or malformed.

Returns

None

Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { // function index(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } // Continue with your application login } }

get_issuer

Extracts the iss from the DID Token.

token.get_issuer(did_token)
Arguments

did_token (str): A DID Token generated by a Magic User on the client-side.

Raises

DIDTokenException if the given DID Token is malformed.

Returns

A Decentralized ID (iss) of the Magic user who generated the DID Token.

Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { // function index(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); $issuer = Magic::token()->get_issuer($did_token); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } // Continue with your application login } }

get_public_address

Gets the cryptographic public address of the Magic User who generated the supplied DID Token.

token.get_public_address(did_token)
Arguments

did_token (str): A DID Token generated by a Magic user on the client-side.

Raises

DIDTokenException if the given DID Token is malformed.

Returns

A public address of the Magic User who generated the DID Token.

Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { // function index(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); $public_address = Magic::token()->get_public_address($did_token); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } // Continue with your application login } }

decode

Decodes a DID Token from a Base64 string into a tuple of its individual components: proof and claim. This method allows you decode the DID Token and inspect the token. You can apply your own rules and validations on top of the current token.validate method.

token.decode(did_token)
Arguments

did_token (str): A DID Token generated by a Magic user on the client-side.

Raises

DIDTokenException if the given DID Token is malformed.

Returns
  • proof (str): A digital signature that proves the validity of the given claim
  • claim (array): Unsigned data the user asserts. This should equal the proof after Elliptic Curve recovery. See Decentralized ID Token Specification for fields inside the claim.
Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { // function index(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); list($proof , $claim) = Magic::token()->decode($did_token); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } // Continue with your application login } }

User Resource

The user resource and its methods are accessible on the Magic instance by the user attribute. It provides methods to interact with the User.

use Magic; Magic::user()->get_metadata_by_issuer('<issuer>'); Magic::user()->get_metadata_by_public_address('<public_address>'); Magic::user()->get_metadata_by_token('<did_token>'); Magic::user()->logout_by_issuer('<issuer>'); Magic::user()->logout_by_public_address('<public_address>'); Magic::user()->logout_by_token('<did_token>');

get_metadata_by_issuer

Retrieves information about the user by the supplied iss from the DID Token. This method is useful if you store the iss with your user data, which is recommended.

user.get_metadata_by_issuer(issuer)
Arguments

issuer (str): The user's Decentralized ID, which can be parsed using token.get_issuer

Raises
  • RateLimitingException: If you have sent too many requests within a given period of time.
  • BadRequestException: If the supplied parameters are invalid.
  • AuthenticationException: If your API secret key cannot be authenticated with Magic API server.
  • ForbiddenException: If your API secret key is not authorized to access the resources.
  • ApiException: For any other API error.
  • ApiConnectionException: If your server cannot communicate with the Magic server. Normally this is a network communication error.
note

See Error Handling for more examples.

Returns
  • A MagicResponse: The data field contains all of the user meta information.
    • issuer (str): The user's Decentralized ID.
    • email (str): The user's email address.
    • public_address (str): The authenticated user's public address (a.k.a.: public key). Currently, this value is associated with the Ethereum blockchain.
Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { // function getMetadata(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); $issuer = Magic::token()->get_issuer($did_token); $user_meta = Magic::user()->get_metadata_by_issuer($issuer); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } // Continue with your application login } }

get_metadata_by_public_address

Retrieves information about the user by the supplied public_address. This method is useful if you store the public_address with your user data.

user.get_metadata_by_public_address(public_address)
Arguments

public_address (str): The user's Ethereum public address, which can be parsed using token.get_public_address.

Raises
  • RateLimitingException: If you have sent too many requests within a given period of time.
  • BadRequestException: If the supplied parameters are invalid.
  • AuthenticationException: If your API secret key cannot be authenticated with Magic API server.
  • ForbiddenException: If your API secret key is not authorized to access the resources.
  • ApiException: For any other API error.
  • ApiConnectionException: If your server cannot communicate with the Magic server. Normally this is a network communication error.
note

See Error Handling for more examples.

Returns
  • A MagicResponse: The data field contains all of the user meta information.
    • issuer (str): The user's Decentralized ID.
    • email (str): The user's email address.
    • public_address (str): The authenticated user's public address (a.k.a.: public key). Currently, this value is associated with the Ethereum blockchain.
Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { // function getMetadata(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); $public_address = Magic::token()->get_public_address($did_token); $user_meta = Magic::user()->get_metadata_by_public_address($public_address); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } // Continue with your application login } }

get_metadata_by_token

Retrieves information about the user by the supplied DID Token.

user.get_metadata_by_token(did_token)
Arguments

did_token (str): A DID Token generated by a Magic User on the client-side.

Raises
  • RateLimitingException: If you have sent too many requests within a given period of time.
  • BadRequestException: If the supplied parameters are invalid.
  • AuthenticationException: If your API secret key cannot be authenticated with Magic API server.
  • ForbiddenException: If your API secret key is not authorized to access the resources.
  • ApiException: For any other API error.
  • ApiConnectionException: If your server cannot communicate with the Magic server. Normally this is a network communication error.
note

See Error Handling for more examples.

Returns
  • A MagicResponse: The data field contains all of the user meta information.
    • issuer (str): The user's Decentralized ID.
    • email (str): The user's email address.
    • public_address (str): The authenticated user's public address (a.k.a.: public key). Currently, this value is associated with the Ethereum blockchain.
Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { // function getMetadata(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); $user_meta = Magic::user()->get_metadata_by_token($did_token); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } // Continue with your application login } }

logout_by_issuer

Logs a user out of all Magic SDK sessions given the user's Decentralized ID (iss). This method is useful if you store the iss with your user data, which is recommended.

user.logout_by_issuer(issuer)
Arguments

issuer (str): The user's Decentralized ID, which can be parsed using token.get_issuer

Raises
  • RateLimitingException: If you have sent too many requests within a given period of time.
  • BadRequestException: If the supplied parameters are invalid.
  • AuthenticationException: If your API secret key cannot be authenticated with Magic API server.
  • ForbiddenException: If your API secret key is not authorized to access the resources.
  • ApiException: For any other API error.
  • ApiConnectionException: If your server cannot communicate with the Magic server. Normally this is a network communication error.
note

See Error Handling for more examples.

Returns

A MagicResponse.

Example

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { function logout(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); $issuer = Magic::token()->get_issuer($did_token); Magic::user()->logout_by_issuer($issuer); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } } }

logout_by_public_address

Logs a user out of all Magic SDK sessions given the user's public address. This method is useful if you store the public_address.

user.logout_by_public_address(public_address)
Arguments

public_address (str): The user's Ethereum public address.

Raises
  • RateLimitingException: If you have sent too many requests within a given period of time.
  • BadRequestException: If the supplied parameters are invalid.
  • AuthenticationException: If your API secret key cannot be authenticated with Magic API server.
  • ForbiddenException: If your API secret key is not authorized to access the resources.
  • ApiException: For any other API error.
  • ApiConnectionException: If your server cannot communicate with the Magic server. Normally this is a network communication error.
note

See Error Handling for more examples.

Returns

A MagicResponse.

Example

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { function logout(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); $public_address = Magic::token()->get_public_address($did_token); Magic::user()->logout_by_public_address($public_address); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } } }

logout_by_token

Logs a user out of all Magic SDK sessions given the DID Token.

user.logout_by_token(did_token)
Arguments

did_token (str): A DID Token generated by a Magic user on the client-side.

Raises
  • RateLimitingException: If you have sent too many requests within a given period of time.
  • BadRequestException: If the supplied parameters are invalid.
  • AuthenticationException: If your API secret key cannot be authenticated with Magic API server.
  • ForbiddenException: If your API secret key is not authorized to access the resources.
  • ApiException: For any other API error.
  • ApiConnectionException: If your server cannot communicate with the Magic server. Normally this is a network communication error.
note

See Error Handling for more examples.

Returns

A MagicResponse.

Example
important

It is important to always validate the DID Token before using.

App\Http\Controllers\MagicController.php

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; use Magic; class MagicController extends Controller { function logout(Request $request){ $did_token = $request->bearerToken(); if ($did_token == null) { // DIDT is missing from the original HTTP request header. // You can handle this by remapping it to your application error. } try { // Validate the did token Magic::token()->validate($did_token); Magic::user()->logout_by_token($did_token); } catch (Throwable $e) { // DIDT is malformed. // You can handle this by remapping it to your application error. report($e); return false; } } }

Response and Error Handling

Response

There is only one response object that will be returned from a successful API call

MagicResponse

This is the interface to interact Magic API responses. It will only be returned if the API request status code is between 200 (inclusive) and 300 (exclusive).

You will have access to the following attributes:

  • content (Array): Raw content returned by the API response.
  • status_code (num): HTTP status code for the given request.
  • data (Array): Parsed content.
MagicResponse->content MagicResponse->status_code MagicResponse->data

Errors

The conventional HTTP response is adopted by the SDK. For the status code in :

  • 2XX - Indicates success
  • 4XX - Indicates client errors. Information provided to the SDK is invalid.
  • 5XX - Indicates server errors

Below is the error class inheritance which can help developers to programmatically handle the error cases.

MagicException | |------- DIDTokenException | |------- RequestException | | ------- RateLimitingException | ------- BadRequestException | ------- AuthenticationException | ------- ForbiddenException | ------- ApiException | ------- ApiConnectionException

MagicException

This is the base class of all the Magic SDK errors.

MagicException(message=null)

DIDTokenException

Any DID Token related error. This can mean the given token is malformed or invalid.

RequestException

This is the base class of all the Magic API request errors. This error class will provide details of unsuccessful API requests.

RequestException( $message=null, $http_status=null, $http_code=null, $http_resp_data=null, $http_message=null, $http_error_code=null, $http_request_params=null, $http_request_data=null, $http_method=null );
CodeErrorDescription
429RateLimitingExceptionToo many requests are submitted for a given period of time.
400BadRequestExceptionThe API requests might have missing required fields or bad inputs.
401AuthenticationExceptionThis means your API secret key is invalid.
403ForbiddenExceptionThis normally means the given API secret key doesn't have permission to perform the action on the given resources.
ApiExceptionThis is a generic API error that handlers other status codes that are not explicitly handled. Ex: 500 , 404 , etc.
ApiConnectionExceptionNetwork connection error. This normally means the connection between your application and Magic API server cannot be established.