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.
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.
validate
Validates a 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
get_issuer
Extracts the iss
from the 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
get_public_address
Gets the cryptographic public address of the Magic User who generated the supplied 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
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.
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 givenclaim
claim
(array): Unsigned data the user asserts. This should equal theproof
after Elliptic Curve recovery. See Decentralized ID Token Specification for fields inside theclaim
.
Example
important
It is important to always validate the DID Token before using.
App\Http\Controllers\MagicController.php
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.
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.
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
: Thedata
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
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.
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
: Thedata
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
get_metadata_by_token
Retrieves information about the user by the supplied 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
: Thedata
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
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.
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
Example
App\Http\Controllers\MagicController.php
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
.
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
Example
App\Http\Controllers\MagicController.php
logout_by_token
Logs a user out of all Magic SDK sessions given the 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
Example
important
It is important to always validate the DID Token before using.
App\Http\Controllers\MagicController.php
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.
Errors
The conventional HTTP response is adopted by the SDK. For the status code in :
2XX
- Indicates success4XX
- 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
This is the base class of all the Magic SDK errors.
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.
Code | Error | Description |
---|---|---|
429 | RateLimitingException | Too many requests are submitted for a given period of time. |
400 | BadRequestException | The API requests might have missing required fields or bad inputs. |
401 | AuthenticationException | This means your API secret key is invalid. |
403 | ForbiddenException | This normally means the given API secret key doesn't have permission to perform the action on the given resources. |
โ | ApiException | This is a generic API error that handlers other status codes that are not explicitly handled. Ex: 500 , 404 , etc. |
โ | ApiConnectionException | Network connection error. This normally means the connection between your application and Magic API server cannot be established. |