Uso de la API para Responder a Disputas de Disponibilidad de Servicio de Red Fija

La FCC ha puesto a disposición una API que los ISP pueden utilizar para responder a disputas sobre la disponibilidad del servicio de banda ancha de red fija. Si responden en cantidad a múltiples disputas a través de la API, los proveedores también pueden utilizar un único archivo con información probatoria para responder a varias disputas.

• Documentación de la API: https://us-fcc.app.box.com/v/bdc-filer-api-spec, y el
• Archivo swagger OpenAPI de la API: https://us-fcc.app.box.com/v/bdc-filer-api-swagger
• Paquete python de ejemplo BDCAPI: https://github.com/FCC/bdcapi

Este artículo proporciona información adicional y consejos sobre cómo utilizar la API mediante un ejemplo en python puesto a disposición del público (el paquete python "BDCAPI"). Este ejemplo pretende demostrar cómo un ISP podría acceder a los puntos de acceso de la API (API endpoints, en inglés) de la BDC. Aunque el ejemplo es totalmente funcional y debería permitir a un ISP gestionar respuestas a disputas de disponibilidad de red fija de forma inmediata, el paquete está pensado como prueba de concepto para permitir a las partes interesadas crear sus propias integraciones con la API.

Instalación de Python

Para utilizar el paquete BDCAPI, necesitará instalar Python versión 3.8 o superior con varios paquetes adicionales.Una forma de hacerlo consiste en instalar miniconda (https://docs.conda.io/en/main/miniconda.html) con un ambiente para Python 3.8 o superior.

Instalación de los Requisitos Previos y del Paquete BDCAPI

La forma más sencilla para instalar el paquete BDCAPI requiere que instale primero los paquetes "pip" y "git" y, a continuación, instale el paquete "bdcapi" directamente desde GitHub. Desde la interfaz de línea de comandos de Anaconda / miniconda, instale los requisitos previos ejecutando el siguiente comando:

conda install pip git

Una vez instalados los paquetes "pip" y "git", instale el paquete BDCAPI desde GitHub ejecutando el siguiente comando:

pip install git+https://github.com/FCC/bdcapi

Esto instalará algunos prerrequisitos adicionales, incluyendo los paquetes "click", "pandas", "numpy", "PyYAML" y "requests". Usted puede confirmar que el paquete BDCAPI se ha instalado correctamente ejecutando el siguiente comando:

bdcapi --help

Debería ver un resultado como el siguiente:

Usage: bdcapi [OPTIONS] COMMAND [ARGS]...
Options:
  --version         Show the version and exit.
  --python-version  Show the version and exit.
  -h, --help        Show this message and exit.
Commands:
  fixed
  initialize

Inicialización del Paquete BDCAPI

Tras confirmar que el paquete BDCAPI se ha instalado correctamente, puede configurarlo para su uso posterior. Tenga en cuenta que este paso es opcional y que siempre puede especificar opciones de línea de comandos para proporcionar el nombre de usuario, el token de API y otros parámetros en el momento de ejecutar el comando BDCAPI. Para realizar el proceso de inicialización / configuración, ejecute el siguiente comando:

bdcapi initialize

Tras ejecutar este comando, se le pedirá que introduzca la URL base de BDC (es decir, https://bdc.fcc.gov/ ), su nombre de usuario de BDC y su token de API de 44 caracteres, así como otros parámetros predeterminados que se utilizarán cuando ejecute el comando BDCAPI.

Para obtener un token de API, inicie sesión en el sistema BDC, haga clic en el enlace Manage API Access (quiere decir "Gestionar acceso a API" en inglés) y, a continuación, haga clic en el botón Generate de la sección Token de la página.

Preparación de Archivos para Uso con el Paquete BDCAPI

Tras instalar todos los paquetes necesarios y, opcionalmente, configurar el paquete BDCAPI, deberá preparar su archivo de datos. En concreto, debe preparar:

• Un archivo CSV que contenga la lista de los valores challenge_id sobre los que pretende actuar, con una fila de encabezado (header row, en inglés) que identifique esa columna con el encabezado challenge_id (o cualquier nombre de columna que haya especificado durante el paso de configuración).
  • También puede especificar un nombre de columna diferente con la opción de línea de comandos
    --challenge-file-column

Trabajar con el Paquete BDCAPI

Para acceder al script y obtener más información sobre él, consulte la página GitHub de BDCAPI en https://github.com/FCC/bdcapi.

En cualquier momento, puede obtener detalles de la ayuda con el comando siguiente:

bdcapi --help

o puede obtener detalles adicionales de ayuda para cada subcomando dado de la siguiente forma:

bdcapi COMMAND --help

Ejemplos

Comando de ejemplo para enviar respuestas iniciales múltiples:

bdcapi submit-bulk-initial-response --frn 0032176356 --evidence-file challenge_evidence_file.pdf Dispute virginia_challenges_to_dispute.csv

Comando de ejemplo para enviar respuestas finales múltiples:

bdcapi submit-bulk-final-response Dispute virginia_challenges_to_dispute.csv 1 Yes

Comando de ejemplo para revertir respuestas iniciales múltiples:

bdcapi revert-bulk-initial-response virginia_challenges_to_dispute.csv

Comando de ejemplo para revertir respuestas finales múltiples:

bdcapi revert-bulk-final-response virginia_challenges_to_dispute.csv

Comando de ejemplo para certificar respuestas múltiples:

bdcapi certify-bulk-response virginia_challenges_to_dispute.csv Remove "Jonathan McCormack" "Certification Officer" "jonathan.mccormack@fcc.gov" "202-555-1234"

Responder Cuando se ha Alcanzado una Resolución con el Disputador

Para responder a las disputas para las que usted y el disputador han llegado a un acuerdo o resolución de que sus datos son exactos y no requieren revisiones, debe crear un archivo CSV con la lista de esas disputas y, a continuación, utilizar ese archivo con el subcomando bulk-submit-initial-response del paquete BDCAPI con un response_type con el valor Dispute (queire decir "Rechaso" en inglés) junto con el archivo de informacion probatoria en formato PDF que decida incluir. A continuación, debería poder usar el subcomando bulk-submit-final-response con un response_type de Dispute, identificar el valor resolution_code adecuado e indicar que el challenger_concurrence es Yes. En ese momento, las disputas se enviarán para su adjudicación por parte de la FCC, y el personal de la FCC debería poder adjudicarlas de conformidad con el acuerdo mutuo entre el proveedor y el disputador.

Opciones Adicionales

Existen opciones y argumentos adicionales para cada uno de los comandos anteriores, y ciertos parámetros son necesarios (según las normas) sólo en determinadas circunstancias. Por ejemplo, el archivo de informacion probatoria es necesario cuando se presenta una respuesta inicial a una disputa, pero es opcional cuando se concede o se envia una respuesta final.

El paquete BDCAPI está hecho de forma a realizar solicitudes a la API con un máximo de 1,000 IDs de disputa a la vez y hacer una pausa entre ellas para evitar alcanzar cualquier límite de velocidad. Sin embargo, si tiene problemas con este volumen, puede anular este valor predeterminado para enviar menos de 1,000 respuestas a la vez utilizando la opción --chunk-size (por ejemplo, --chunk-size 500).