xolphin-api 1.7.0
Python library for Xolphin API
License: MIT
Keywords: xolphin

Xolphin API wrapper for Python
==============================

Library installation
--------------------

Library can be installed via `pip <https://pypi.python.org/pypi/pip>`__

::

    pip install xolphin-api

And updated via

::

    pip install xolphin-api --upgrade

Or manually from source

::

    git clone https://github.com/xolphin/xolphin-api-python.git
    cd xolphin-api-python
    python setup.py install

Usage
-----

Client initialization
~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    import xolphin

    client = xolphin.Client('<username>', '<password>')

Requests
~~~~~~~~

Getting list of requests
^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: python

    requests = client.request().all()
    for request in requests:
        print request.id, request.product.id

Getting request by ID
~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    request = client.request().get(961992637)
    print(request.product.brand)

Request certificate
~~~~~~~~~~~~~~~~~~~

.. code:: python

    ccr = client.request().create(24, 1, 'csr string', 'EMAIL')
    ccr.address = 'Address'
    ccr.approver_first_name = 'FirstName'
    ccr.approver_last_name = 'LastName'
    ccr.approver_phone = '+12345678901'
    ccr.approver_email = 'email@domain.com'
    ccr.zipcode = '123456'
    ccr.city = 'City'
    ccr.company = 'Company'
    ccr.subject_alternative_names.append('test1.domain.com')
    ccr.subject_alternative_names.append('test2.domain.com')
    ccr.dcv.append({
        'domain': 'test1.domain.com',
        'dcvType': 'EMAIL',
        'approverEmail': 'email@domain.com'
    })

    request = client.request().send(ccr)
    print(request.id)

Create a note
~~~~~~~~~~~~~

.. code:: python

    result = client.request().send_note(1234, 'My message')
    print(result.message);

Get list of notes
~~~~~~~~~~~~~~~~~

.. code:: python

    result = client.request().get_notes(1234)
    for note in result:
        print(note.messageBody);

Send a "Comodo Subscriber Agreement" email
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    //currently available languages: en, de, fr, nl
    result = client.request().send_ComodoSA(124, 'test@example.com')
    print(result.message);

Request Callback (OV and EV certificates)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

    vc = client.request().configure_validation_call(order_id)
    vc.date = "2024-01-26"
    vc.time = "11:00"
    vc.timezone = "Europe Amsterdam"
    vc.phoneNumber = "132456789"
    request = client.request().send_validation_call(vc);

Certificate
~~~~~~~~~~~

Certificates list and expirations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: python

    certificates = client.certificate().all()
    for certificate in certificates:
        print(certificate.id, certificate.isExpired())

Download certificate
^^^^^^^^^^^^^^^^^^^^

.. code:: python

    cert = client.certificate().download(961983489, 'CRT')
    with open('crt.crt', 'wb') as f:
        f.write(cert)

Support
~~~~~~~

Products list
^^^^^^^^^^^^^

.. code:: python

    products = client.support().products()
    for product in products:
        print(product.id, product.brand)

Decode CSR
^^^^^^^^^^

.. code:: js

    data = client.support().decode_csr('csr string')
    print(data.type, data.size)