Umuly

Umuly - Url shortener api documentation

Import our API Collections via the
or Web Postman Github button.
  • 1 - What Is Umuly?

    Umuly, is a web api service that allows you to create and share a short URL for your domain.

  • 2 - Account

    • 2.1 - Create An Account

      Url Method Description
      /api/user Post API to be used to create an user account. To use Umuly, which is a url shortner API, you should first create a Umuly account.
      Request
      Parameter Type Required Description
      Name string true Name of the person to register. For example; Ahmet Yılmaz (first name)
      Email string true E-mail of the person to register. For example; [email protected]

      An e-mail address can be used for only one account. If a new account is created and the entered e-mail address is already exist in the system, you must be register with another e-mail.

      Since the e-mail address entered will be used for mail verification at the end of the registration process, a valid e-mail address must be entered.
      (Account verification link will be sent to this e-mail address and it must be clicked and opened to confirm the verification process.)
      Password string true The password that will be used to access the application. Password must contains all of the following requirements;
      US-ASCII character encoding
      At least eight characters
      At least one uppercase character
      At least one lowercase character
      At least one number
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string Registration ID of the person created as a result of user registration process.
      Item(Email) string Email address that the user entered when registering.
      Item(Name) string Name and surname that the user entered when registering.
      Item(ProfilePhoto) string Profile photo of the user.
    • 2.2 - Verify Your Account

      Verification is carried out by opening the verification link sent to the email address.

    • 2.3 - Reset Your Password

      Url Method Description
      /api/user/reset-password Post API to be used to reset password. If you have forgotten your password, you can use this API to reset your current password to create a new password. The reset link will be sent to the e-mail address you have defined in Umuly. The e-mail address registered in the system must be active and accessible.
      Request
      Parameter Type Required Description
      Email string true The email address connected to your account for a password reset must be registered in the system.

      A reset code will be sent to the your e-mail address after you sent a reset the password request. This code will be used in change password service (On section 2.4).
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
    • 2.4 - Change Your Password

      Url Method Description
      /api/user/change-password Post API to be used to change user password. After the reset API runs, a reset code will be sent to the e-mail address you entered as the input in the reset API. In the API, e-mail and new password information, as well as this reset code information, must be entered as input. The new password must meet the criteria for creating a password.
      Request
      Parameter Type Required Description
      Email string true Registered e-mail address which will be used to change password.
      Password string true New password information that you haven't already used with this account and must include required password criteria.
      Code string true Verification code which was sent to your email after reset password request.
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
  • 3 - Get Token Information

    Url Method Description
    /api/token?email={email}&password={password} Get API to be used to authorize the user with the email and password so that the user can take action in the application. When token API runs, an authentication is made from the email and password information provided as input, and if validation is successful, token information is sent
    Request
    Parameter Type Required Description
    email string true Registered e-mail address which will be used to authorize to access the API.
    password string true Registered password which will be used to authorize to access the API.
    Response
    Parameter Type Description
    Token string Token information to be returned if email and password information of the requester is verified.
  • 4 - Inquire User Profile Information

    Url Method Description
    /api/my Get API to be used to return active user information.
    Request
    Parameter Type Required Description
    Headers.Authorization string true Headers.Authorization= Bearer {Token}
    Response
    Parameter Type Description
    Status int Status information of the service result. If successful, it takes 200 message.
    StatusText string Textual expression of the status information of the error code.
    Item object, array
    ItemCount int Number of records found after the query completed.
    SkipCount int Total page count of records found in the query.
    RequestDate date time Request time of the user.
    ResponseDate date time Response time after server operations is completed.
    Item(Id) string Record ID of the user which is created as a result of the registration process of the user.
    Item(Email) string The e-mail address that the user entered when registering.
    Item(Name) string Name and surname information that the user entered when registering.
    Item(ProfilePhoto) string Profile photo of the user.
  • 5 - Edit Profile Informations

    Url Method Description
    /api/my Put API to be used to update user profile informations. You can update your Umuly profile informations (name and profile photo) using this API
    Request
    Parameter Type Required Description
    Name string true Name, surname infromation of the user. For example; Ahmet Yılmaz
    ProfilePhoto string false Profile photo of the user. It must be on Base64 format.
    Headers.Authorization string true Headers.Authorization = Bearer {Token}
    Response
    Parameter Type Description
    Status int Status information of the service result. If successful, it takes 200 message.
    StatusText string Textual expression of the status information of the error code.
    Item object, array
    ItemCount int Number of records found after the query completed.
    SkipCount int Total page count of records found in the query.
    RequestDate date time Request time of the user.
    ResponseDate date time Response time after server operations is completed.
    Item(Id) string Record ID of the user which is created as a result of the registration process of the user.
    Item(Email) string The e-mail address that the user entered when registering.
    Item(Name) string Name and surname information that the user entered when registering.
    Item(ProfilePhoto) string Profile photo of the user.
  • 6 - Domain Operations

    • 6.1 - Inquire Single Domain

      Url Method Description
      /api/domains/{domainId} Get API to be used to get the domain details corresponding to the related domain ID. This API is used for a particular domain and corresponding domain id should be sent as input value.
      Request
      Parameter Type Required Description
      DomainId string true ID information of the registered domain.
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the domain.
      Item(Name) string Name of the domain.
      Item(Url) string Full address of domain (with http or https)
    • 6.2 - Inquire Multiple Domain

      Url Method Description
      /api/domains Get API to be used to get a list of all domains of the user. This API will run for all of your active domains (not for a particular domain) defined in Umuly.
      Request
      Parameter Type Required Description
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the domain.
      Item(Name) string Name of the domain.
      Item(Url) string Full address of domain (with http or https)
    • 6.3 - Add a New Domain

      Url Method Description
      /api/domains Post API to be used to add a user-specific domain. Only premium account users can create their own domains using this service.If you don't have a premium package yet, you can buy a package and create custom domains, or you can first create custom domains and then buy a package to activate the corresponding service.
      Request
      Parameter Type Required Description
      Name string true Name of the domain.
      DomainUrl string true Full address of domain (with http or https)
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the domain.
      Item(Name) string Name of the domain.
      Item(Url) string Full address of domain (with http or https)
    • 6.4 - Update Domain Informations

      Url Method Description
      /api/domains/{domainId} Put API to be used to update the informations (name and domain url) of a custom domain.
      Request
      Parameter Type Required Description
      Name string true Name of the domain.
      DomainUrl string true Full address of domain (with http or https)
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the domain.
      Item(Name) string Name of the domain.
      Item(Url) string Full address of domain (with http or https)
    • 6.5 - Delete a Domain

      Url Method Description
      /api/domains/{domainId} Delete API to be used to delete a user-specific domain.
      Request
      Parameter Type Required Description
      DomainId string true ID of the registered domain.
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
    • 6.6 - Name Server Settings

      You must change your DNS (Domain Name Server) like clay.ns.cloudflare.com, gene.ns.cloudflare.com etc.

  • 7 - URL Operations

    • 7.1 - Inquire Single URL

      Url Method Description
      /api/url/{urlId} Get API to be used to get the domain details corresponding to the related URL ID.
      Request
      Parameter Type Required Description
      UrIId string true ID information of the registered URL.
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the URL.
      Item(DomainId) string ID of the domain of related URL.
      Item(Code) string Raw code for short URL.
      Item(RedirectUrl) string Redirection address.
      Item(ShortUrl) string Short URL address.
    • 7.2 - Inquire Multiple URL

      Url Method Description
      /api/url?Skip={PageNumber}&Domain={Domain}&Code={Code}&RedirectUrl={RedirectUrl} Get Returns all URLs corresponding to the related parameters.
      There are 10 records per page.
      Request
      Parameter Type Required Description
      Skip int false The number of the page where the URLs are listed. The default value is 0.
      Domain string false Domain address information.
      Code string false Short code information.
      RedirectUrl string false Redirection address defined by the user.
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the URL.
      Item(DomainId) string ID of the domain of related URL.
      Item(Code) string Raw code for short URL.
      Item(RedirectUrl) string Redirection address.
      Item(ShortUrl) string Short URL address.
    • 7.3 - Create Your Short URL

      Url Method Description
      /api/url Post API to be used to create short URL by user. If you don’t have a premium package yet, you can buy a package to create custom domains and create short links using this domains, or you can first create custom domains, then create short links using this domains and then buy a package to enable the corresponding service.
      Request
      Parameter Type Required Description
      DomainId string true ID of the registered domain.
      If no domain ID information is given, default domain will be “umuly.com".
      RedirectUrl string true Redirection address defined by the user.
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the URL.
      Item(DomainId) string ID of the domain of related URL.
      Item(Code) string Raw code for short URL.
      Item(RedirectUrl) string Redirection address.
      Item(ShortUrl) string Short URL address.
    • 7.4 - Update Your Short URL

      Url Method Description
      /api/url Put API to be used to update the domain and redirect URL informations that belong to the related short url.
      Request
      Parameter Type Required Description
      UrlId string true ID information of the URL.
      DomainId string true ID of the registered domain.
      If no domain ID information is given, default domain will be “umuly.com".
      RedirectUrl string true Redirection address defined by the user.
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      Item object, array
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
      Item(Id) string ID of the URL.
      Item(DomainId) string ID of the domain of related URL.
      Item(Code) string Raw code for short URL.
      Item(RedirectUrl) string Redirection address.
      Item(ShortUrl) string Short URL address.
    • 7.5 - Delete Your Short URL

      Url Method Description
      /api/url/{urlId} Delete API to be used to delete a user-specific url. To perform the delete operation, url id of the short url to be deleted must be sent as input.
      Request
      Parameter Type Required Description
      UrlId string true ID information of the registered URL.
      Headers.Authorization string true Headers.Authorization= Bearer {Token}
      Response
      Parameter Type Description
      Status int Status information of the service result. If successful, it takes 200 message.
      StatusText string Textual expression of the status information of the error code.
      ItemCount int Number of records found after the query completed.
      SkipCount int Total page count of records found in the query.
      RequestDate date time Request time of the user.
      ResponseDate date time Response time after server operations is completed.
Attention: Only premium account users can create their own domains. If you don't have a premium package yet, you can buy a package and create custom domains, or you can first create custom domains and then buy a package to activate the corresponding service.

- If you want to use custom domain you must set (clay.ns.cloudflare.com,gene.ns.cloudflare.com) information of name server. Or contact with place where your custom domain register.

Visa Card Master Card Source SSL Encryption

©Copyright Umuly All rights reserved.